diff --git a/.github/scripts/generate_resource_references.py b/.github/scripts/generate_resource_references.py index 1288c9ba4..6dab0603d 100644 --- a/.github/scripts/generate_resource_references.py +++ b/.github/scripts/generate_resource_references.py @@ -19,16 +19,154 @@ import os import sys +import json +import re +# Generated resource pages (namespace indexes, API-version indexes, and +# individual resource schema pages) omit a description. The listing partials +# render the page title as the link text, so a "Reference documentation for +# " description would only repeat the title. hugo_template = """--- type: docs -title: "Reference: {}" +title: "{}" linkTitle: "{}" -description: "Detailed reference documentation for {}" --- """ +# Namespace segment display-name overrides, used for capitalization that does +# not follow simple title-casing (e.g. "ai" -> "AI"). +namespace_segment_overrides = {"ai": "AI"} + +# Namespace-parent directories to skip. The legacy "applications" tree holds the +# retired Applications.* resource types, which are no longer documented. +excluded_namespace_parents = {"applications"} + +def display_name(namespace): + return ".".join( + namespace_segment_overrides.get(segment, segment.capitalize()) + for segment in namespace.split(".") + ) + +# The resource markdown filenames are all lowercase (e.g. "bicepsettings.md"), +# but the canonical resource name is camelCased (e.g. "bicepSettings"). The +# authoritative casing lives in the sibling "types.json" as fully qualified type +# names like "Radius.Core/bicepSettings@2025-08-01-preview". Build a map from the +# lowercased resource segment to its canonical camelCase spelling so headings and +# link titles use the correct casing. +def load_canonical_resource_names(types_json_path): + canonical = {} + if not os.path.exists(types_json_path): + return canonical + try: + data = json.load(open(types_json_path, 'r')) + except (ValueError, OSError): + return canonical + + def walk(node): + if isinstance(node, dict): + for key, value in node.items(): + if key == 'name' and isinstance(value, str) and '/' in value and '@' in value: + resource_segment = value.split('/', 1)[1].split('@', 1)[0] + canonical[resource_segment.lower()] = resource_segment + walk(value) + elif isinstance(node, list): + for item in node: + walk(item) + + walk(data) + return canonical + +# The emitter wraps the resource @doc prose under a top-level "## Description" +# heading, but the authored prose uses "##" for its own subsections (e.g. +# "Defining an Application"), which makes them siblings of Description instead of +# children. Demote every "##" heading between "## Description" and the first +# schema section to "###", leaving "## Description" and the schema section +# headings untouched. Fenced code blocks are skipped so "##" inside code is not +# altered. +def demote_description_headings(markdown_content): + schema_headings = ("## Top-Level Properties", "## Object Properties", "## Properties") + in_description = False + in_fence = False + result = [] + for line in markdown_content.splitlines(keepends=True): + stripped = line.rstrip("\n") + if stripped.startswith("```"): + in_fence = not in_fence + result.append(line) + continue + if not in_fence: + if stripped == "## Description": + in_description = True + result.append(line) + continue + if in_description and stripped in schema_headings: + in_description = False + if in_description and stripped.startswith("## "): + line = "#" + line + result.append(line) + return "".join(result) + +# Each schema table carries "Required" and "Read-Only" columns that only ever +# hold "false"/"true". That information is already restated in the Description +# column, which begins with "(Optional)", "(Required)", or "(Read Only)", so the +# dedicated boolean columns are redundant and waste horizontal space (crowding +# the Description). Drop those columns from every table, keeping Property, Type, +# and Description. Columns to remove are identified per-table from the header row. +# Cells are split on unescaped pipes only, so enum unions such as +# "'A' \| 'B' \| 'C'" in the Type column are kept intact rather than mistaken for +# extra columns. +_UNESCAPED_PIPE = re.compile(r"(?<!\\)\|") + +def strip_boolean_columns(markdown_content): + columns_to_drop = {"Required", "Read-Only"} + drop_indices = None + result = [] + for line in markdown_content.splitlines(keepends=True): + newline = "\n" if line.endswith("\n") else "" + stripped = line.strip() + if stripped.startswith("|") and stripped.endswith("|"): + # Split on unescaped pipes; drop the empty leading/trailing cells + # produced by the outer table pipes. + raw_cells = _UNESCAPED_PIPE.split(stripped)[1:-1] + cells = [c.strip() for c in raw_cells] + if drop_indices is None and columns_to_drop.issubset(set(cells)): + drop_indices = {idx for idx, c in enumerate(cells) if c in columns_to_drop} + if drop_indices is not None: + kept = [c for idx, c in enumerate(raw_cells) if idx not in drop_indices] + result.append("|" + "|".join(kept) + "|" + newline) + continue + else: + # A non-table line ends the current table. + drop_indices = None + result.append(line) + return "".join(result) + +# Top-level section index for the flattened resource schema tree. The +# namespace-parent directory level (e.g. "radius") is flattened away so the +# namespaces appear directly under a single "Resource schemas" section. +section_index_template = """--- +type: docs +title: "Resource Types" +linkTitle: "Resource Types" +description: "Schema reference for built-in Resource Types" +weight: 200 +--- + +## Introduction + +Resource Types define the schema for the resources developers use to model their applicationsβ€”the properties you can configure, the values Radius returns, and the API versions each type supports. For a deeper explanation of what Resource Types are and how they abstract the underlying infrastructure, see the [Resource Types concepts]({{< ref "concepts/resource-types" >}}) page. + +`Radius.Core` Resource Types are embedded in the Radius control plane. All other Resource Types are sourced from the [resource-types-contrib](https://github.com/radius-project/resource-types-contrib) repository. + +All of the schema information on these pages is also available directly from your environment using [`rad resource-type list`]({{< ref rad_resource-type_list >}}) and [`rad resource-type show`]({{< ref rad_resource-type_show >}}), as well as through the [Radius Dashboard]({{< ref "/guides/installation/dashboard/overview" >}}). + +## How this section is organized + +Resource Types are organized first by namespace (such as `Radius.Core`, `Radius.Compute`, and `Radius.Data`) and then by API version (for example, `2025-08-01-preview`). Open a Resource Type to view its schema reference, which documents the resource's properties, including which fields are required and read-only. + +""" + # Ensure that the script is called with the correct number of arguments if len(sys.argv) != 3: print("Usage: python generate_resource_references.py <source_directory> <target_directory>") @@ -53,16 +191,19 @@ print("No namespace parents found in source directory: {}".format(source_directory)) sys.exit(1) +# Create the top-level "Resource schemas" section index. +os.makedirs(target_directory, exist_ok=True) +with open(os.path.join(target_directory, '_index.md'), 'w') as f: + f.write(section_index_template) + # Iterate through each namespace parent directory for each namespace for namespace_parent in namespace_parents: if not os.path.isdir(os.path.join(source_directory, namespace_parent)): continue - # Create _index.md file for namespace parent - target_namespace_parent_dir = os.path.join(target_directory, namespace_parent, '_index.md') - os.makedirs(os.path.dirname(target_namespace_parent_dir), exist_ok=True) - with open(target_namespace_parent_dir, 'w') as f: - f.write(hugo_template.format(namespace_parent, namespace_parent, namespace_parent)) + # Skip retired namespace-parent trees (e.g. legacy Applications.* types). + if namespace_parent in excluded_namespace_parents: + continue namespaces = os.listdir(os.path.join(source_directory, namespace_parent)) if not namespaces: @@ -73,11 +214,11 @@ if not os.path.isdir(os.path.join(source_directory, namespace_parent, namespace)): continue - # Create _index.md file for namespace - target_namespace_dir = os.path.join(target_directory, namespace_parent, namespace, '_index.md') + # Create _index.md file for namespace (flattened directly under target) + target_namespace_dir = os.path.join(target_directory, namespace, '_index.md') os.makedirs(os.path.dirname(target_namespace_dir), exist_ok=True) with open(target_namespace_dir, 'w') as f: - f.write(hugo_template.format(namespace, namespace, namespace)) + f.write(hugo_template.format(display_name(namespace), display_name(namespace))) api_versions = os.listdir(os.path.join(source_directory, namespace_parent, namespace)) if not api_versions: @@ -89,25 +230,35 @@ continue # Create _index.md file for API version - target_api_version_dir = os.path.join(target_directory, namespace_parent, namespace, api_version, '_index.md') + target_api_version_dir = os.path.join(target_directory, namespace, api_version, '_index.md') os.makedirs(os.path.dirname(target_api_version_dir), exist_ok=True) with open(target_api_version_dir, 'w') as f: - f.write(hugo_template.format(api_version, api_version, api_version)) + f.write(hugo_template.format(api_version, api_version)) resource_markdown_files = os.listdir(os.path.join(source_directory, namespace_parent, namespace, api_version, 'docs')) if not resource_markdown_files: print("No resource markdown files found in namespace {} and API version: {}".format(namespace, api_version)) continue + # Canonical (camelCase) resource names keyed by lowercase segment. + canonical_resource_names = load_canonical_resource_names( + os.path.join(source_directory, namespace_parent, namespace, api_version, 'types.json')) + for resource_markdown_file in resource_markdown_files: if not resource_markdown_file.endswith(".md"): continue resource_name = resource_markdown_file.split(".")[0] - print("Processing resource: {}/{}@{}".format(namespace, resource_name, api_version)) - target_resource_dir = os.path.join(target_directory, namespace_parent, namespace, api_version, resource_name) + # Use the canonical camelCase spelling for the resource segment + # (e.g. "bicepSettings" instead of the lowercase filename). + canonical_name = canonical_resource_names.get(resource_name.lower(), resource_name) + # PascalCase title for the sidebar/table of contents link. + link_title = canonical_name[:1].upper() + canonical_name[1:] + print("Processing resource: {}/{}@{}".format(namespace, canonical_name, api_version)) + target_resource_dir = os.path.join(target_directory, namespace, api_version, resource_name) - hugo_content = hugo_template.format('{}/{}@{}'.format(namespace, resource_name, api_version), resource_name, '{}/{}@{}'.format(namespace, resource_name, api_version)) + qualified_name = '{}/{}@{}'.format(display_name(namespace), canonical_name, api_version) + hugo_content = hugo_template.format(qualified_name, link_title) hugo_content += "{{< schemaExample >}}\n\n" ## Check if a Bicep file exists for the resource @@ -125,8 +276,7 @@ # Add in the resource markdown file markdown_content = open(os.path.join(source_directory, namespace_parent, namespace, api_version, 'docs', resource_markdown_file), 'r').read() - hugo_content += "## Schema\n\n" - hugo_content += markdown_content + hugo_content += strip_boolean_columns(demote_description_headings(markdown_content)) # Create the target markdown file target_markdown_file = os.path.join(target_resource_dir, 'index.md') diff --git a/bicepconfig.json b/bicepconfig.json index e47f94282..d1b37952c 100644 --- a/bicepconfig.json +++ b/bicepconfig.json @@ -1,8 +1,5 @@ // The bicepconfig.json file is needed so the bicep files in the repo can be compiled with the correct setup { - "experimentalFeaturesEnabled": { - "extensibility": true - }, "extensions": { "radius": "br:biceptypes.azurecr.io/radius:latest", "aws": "br:biceptypes.azurecr.io/aws:latest" diff --git a/docs/assets/scss/_content.scss b/docs/assets/scss/_content.scss index 1877aafe3..94aeff12f 100644 --- a/docs/assets/scss/_content.scss +++ b/docs/assets/scss/_content.scss @@ -44,14 +44,35 @@ @extend .img-fluid; } - > table { + > table:not(.td-initial) { @extend .table-striped; - @extend .table-responsive; - @extend .table-bordered; @extend .table; + + // Render as a normal table rather than Docsy's responsive + // `display: block` (which sets `display: block` and adds horizontal + // scrolling). The `:not(.td-initial)` qualifier matches the specificity + // of Docsy's own responsive-table rule so `display: table` wins the + // cascade. + display: table; + width: 100%; + + // Use a fixed layout but WITHOUT any hard-coded per-column widths. With + // no `<col>`/`width` rules, the fixed algorithm divides the table width + // equally among columns (2 columns β†’ 50/50, 3 β†’ thirds, 4 β†’ quarters). + // This is dynamic to the column count, never lets one column hog the + // width, and gives every column enough room that ordinary words like + // "string" or "boolean" are never broken mid-word. A genuinely long, + // unbreakable token (e.g. a UCP resource ID) wraps within its column + // via `overflow-wrap: anywhere` instead of forcing the table wide. + table-layout: fixed; + + td, th { + overflow-wrap: anywhere; + word-break: normal; + } } > blockquote { @@ -81,6 +102,27 @@ .lead { margin-bottom: 1.5rem; } + + // The Docsy `tabs`/`codetab` shortcodes render each tab's body in a + // `.tab-pane` that has no horizontal padding, so paragraphs and code blocks + // sit flush against the tab-content border. Inset the content from the + // border for readability. + .tab-content .tab-pane { + padding: 1rem; + + // The shortcode injects a leading <br> for top spacing; the padding now + // provides it, so hide the redundant break. + > br:first-child { + display: none; + } + + // Docsy's tab styling resets `.highlight` to `margin: 0` inside a tab + // pane, which removes the spacing between a code block and the text that + // follows it. Restore a bottom margin so code blocks aren't cramped. + .highlight { + margin-bottom: 1rem; + } + } } .td-title { diff --git a/docs/assets/scss/_styles_project.scss b/docs/assets/scss/_styles_project.scss index 59e32bf26..1978304a1 100644 --- a/docs/assets/scss/_styles_project.scss +++ b/docs/assets/scss/_styles_project.scss @@ -19,6 +19,12 @@ display: none; } +// Add breathing room above the "Feedback" footer section so it isn't crowded +// against the preceding page content. +.feedback--title { + margin-top: 2rem; +} + .btn-success { background: #3176d9; background-color: #3176d9; diff --git a/docs/config.toml b/docs/config.toml index 06ab8da2c..60b2e7497 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -25,9 +25,6 @@ path = "github.com/google/docsy" source = "content" target = "content" [[module.mounts]] -source = "shared-content" -target = "content" -[[module.mounts]] source = "static" target = "static" [[module.mounts]] diff --git a/docs/content/_index.md b/docs/content/_index.md index 165161ed7..57ea8b5ed 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -22,7 +22,7 @@ Radius is a cloud native application platform. It enables developers and IT ope {{< card header="**πŸŽ“ Tutorials**" footer="[**View available tutorials β†’**]({{< ref tutorials >}})" >}} Visit the tutorials for guided learning paths to try out Radius and pick up the main concepts. We'll walk you through the steps to get started with Radius and run your first set of apps. {{< /card >}} - {{< card header="**πŸ“˜ How-to guides**" footer="[**Visit how-to guides β†’**]({{< ref guides >}})" >}} + {{< card header="**πŸ“˜ How-to guides**" footer="[**Visit how-to guides β†’**]({{< ref applications >}})" >}} Check out the how-to guides for step-by-step instructions on how to use Radius and its features. We'll walk you through how to accomplish specific tasks when using Radius. {{< /card >}} {{< /cardpane >}} @@ -30,7 +30,7 @@ Radius is a cloud native application platform. It enables developers and IT ope {{< card header="**πŸ’­ Concepts**" footer="[**Learn the concepts β†’**]({{< ref concepts >}})" >}} Learn about the background and concepts behind Radius with in-depth explanations. We'll cover the main concepts and how Radius works, so you have the broader context to deeply understand Radius and use it most effectively. {{< /card >}} - {{< card header="**🧾 Reference**" footer="[**Visit reference material β†’**]({{< ref guides >}})" >}} + {{< card header="**🧾 Reference**" footer="[**Visit reference material β†’**]({{< ref reference >}})" >}} Refer to detailed information on Radius resources, APIs, FAQs, and more. Reference material is useful for looking up specific information about Radius when you need it. {{< /card >}} {{< /cardpane >}} diff --git a/docs/content/applications/_index.md b/docs/content/applications/_index.md new file mode 100644 index 000000000..b72991f0e --- /dev/null +++ b/docs/content/applications/_index.md @@ -0,0 +1,9 @@ +--- +type: docs +title: "Manage applications" +linkTitle: "Manage applications" +description: "Deploy and manage Applications and the resources that make them up" +weight: 600 +--- + +Learn how to deploy an Application to an Environment, use connections to model dependencies between resources, configure ingress with Routes to expose services to the internet, and override Kubernetes resource configurations when you need finer control over the underlying platform. diff --git a/docs/content/applications/connections/index.md b/docs/content/applications/connections/index.md new file mode 100644 index 000000000..e03f778a2 --- /dev/null +++ b/docs/content/applications/connections/index.md @@ -0,0 +1,155 @@ +--- +type: docs +title: "How to model application dependencies using connections" +linkTitle: "Model application dependencies" +description: "Learn how to use connections to model dependencies within your application" +weight: 200 +aliases: + - /guides/connections/ +--- + +A connection is an explicit relationship between two resources in your [Application]({{< ref "/concepts/applications" >}}). Declaring a connection from a Container to another resource adds an edge to the Application graph and injects the connected resource's properties into the Container as environment variables. Your application then reads those variables instead of hard-coding hosts, ports, or credentials. + +This guide adds a Redis cache to an application and connects a Container to it. It builds on the definition from [How to model an application definition]({{< ref "/applications/definitions" >}}). + +## Step 1: Start from an application definition + +Begin with a definition that declares an Application and a Container. The following `app.bicep` defines a `frontend` Container: + +```bicep +extension radius + +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string + +resource app 'Radius.Core/applications@2025-08-01-preview' = { + name: 'my-app' + properties: { + environment: environment + } +} + +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: app.id + containers: { + web: { + image: 'ghcr.io/radius-project/samples/demo:latest' + ports: { + web: { + containerPort: 3000 + } + } + } + } + } +} +``` + +See [How to model an application definition]({{< ref "/applications/definitions" >}}) to build this file from scratch. + +## Step 2: Add the resource to connect to + +Add the dependency the Container needs. The following example adds a `Radius.Data/redisCaches` resource named `db` to the same Application: + +```bicep +resource db 'Radius.Data/redisCaches@2025-08-01-preview' = { + name: 'db' + properties: { + environment: environment + application: app.id + } +} +``` + +## Step 3: Connect the Container to the resource + +Add a `connections` entry to the Container's `properties`. Each connection has a name and a `source` set to the target resource's `.id`: + +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: app.id + containers: { + web: { + image: 'ghcr.io/radius-project/samples/demo:latest' + ports: { + web: { + containerPort: 3000 + } + } + } + } + connections: { + redis: { + source: db.id + } + } + } +} +``` + +The connection name (`redis`) becomes the prefix of the environment variables Radius injects into the Container. Referencing `db.id` also orders the deployment so Radius creates the cache before the Container. + +## Step 4: Deploy the application + +Deploy the updated definition with [`rad deploy`]({{< ref rad_deploy >}}): + +```bash +rad deploy app.bicep +``` + +Radius provisions the Redis cache, injects its connection details into the Container, and records the connection in the Application graph. + +## Step 5: Inspect the connection in the Application graph + +Use [`rad application graph`]({{< ref rad_application_graph >}}) to view the resources and the connection between them: + +<!-- TODO: Remove the `--preview` flag when the Radius.Core Application implementation is no longer in preview. --> +```bash +rad application graph --application my-app --preview +``` + +The output shows the `frontend` Container connected to the `db` cache, along with the infrastructure each resource created: + +```text +Displaying application: my-app + +Name: frontend (Radius.Compute/containers) +Connections: + frontend -> db (Radius.Data/redisCaches) +Resources: + frontend (kubernetes: apps/Deployment) + frontend (kubernetes: core/Service) + +Name: db (Radius.Data/redisCaches) +Connections: + frontend (Radius.Compute/containers) -> db +Resources: + db (kubernetes: apps/Deployment) + db (kubernetes: core/Service) +``` + +## Connection environment variables + +When a Container connects to another resource, Radius injects an environment variable for each property the connected resource exposes. The variables follow the pattern `CONNECTION_<CONNECTION-NAME>_<PROPERTY-NAME>`, uppercased. Radius manages the values securely through the Environment. + +For the `redis` connection above, Radius injects a variable for each property the Redis cache exposes. For example, a cache that returns `host`, `port`, and `password` produces: + +- `CONNECTION_REDIS_HOST` +- `CONNECTION_REDIS_PORT` +- `CONNECTION_REDIS_PASSWORD` + +The exact variables depend on the properties defined by the connected Resource Type. See the [Resource Types reference]({{< ref "/reference/resources" >}}) for each type's properties, and [Connections]({{< ref "/concepts/applications#connections" >}}) in the Applications concept for how the graph and variables are built. + +To use your own naming convention, ignore the generated variables and set explicit environment variables on the Container instead. + +## Next steps + +With the dependency connected, deploy and manage the complete Application. + +{{< button text="Next step: How to deploy applications using Radius" page="/applications/deploy" >}} diff --git a/docs/content/applications/definitions/_index.md b/docs/content/applications/definitions/_index.md new file mode 100644 index 000000000..3cf019955 --- /dev/null +++ b/docs/content/applications/definitions/_index.md @@ -0,0 +1,122 @@ +--- +type: docs +title: "How to model an application definition" +linkTitle: "Model application resources" +description: "Learn how to model an application using Bicep and Radius Resource Types" +weight: 100 +--- + +An application definition is a Bicep file that declares your [Application]({{< ref "/concepts/applications" >}}) and the resources it is made of. You model each resource with a [Resource Type]({{< ref "/concepts/resource-types" >}}), and Radius provisions the backing infrastructure when you deploy the file. This guide builds an `app.bicep` definition from an empty file, adds resources, and references dependencies between them. + +When the definition is ready, see [How to deploy applications using Radius]({{< ref "/applications/deploy" >}}) to deploy it to an Environment. + +## Step 1: Import the Radius extension + +Create a Bicep file for your application and import the Radius Bicep extension. This guide uses `app.bicep`, but the file can have any name. The extension makes the Radius Resource Types available in Bicep: + +```bicep +extension radius +``` + +The `radius` extension is configured in the `bicepconfig.json` created by `rad initialize`. If you have custom resource types to use, see [Add custom resource types to bicepconfig.json]({{< ref "/installation/dev-workstation#configure-bicepconfigjson" >}}). + +## Step 2: Declare the Environment parameter + +Every Application targets a Radius [Environment]({{< ref "/concepts/environments" >}}). Declare an `environment` parameter so the Radius CLI can supply the selected Environment's resource ID when you deploy: + +```bicep +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string +``` + +You do not set this value yourself. `rad deploy` passes the Environment from the current [Workspace]({{< ref "/management/workspaces" >}}), or from the `--environment` flag. + +## Step 3: Define the Application resource + +Declare a `Radius.Core/applications` resource to group the resources that make up your application. Set its `environment` property to the parameter: + +```bicep +resource app 'Radius.Core/applications@2025-08-01-preview' = { + name: 'my-app' + properties: { + environment: environment + } +} +``` + +The Application records the resources that belong to it and the relationships between them. Radius uses it to build the Application graph and to manage the resources together. + +## Step 4: Add resources with Resource Types + +Add the resources your application needs. Each resource uses a Resource Type and sets two properties that associate it with the Application: + +- `environment` links the resource to the Radius Environment. +- `application` links the resource to the Application, using the Application's `.id`. + +The following example adds a container that runs the application's front end: + +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: app.id + containers: { + web: { + image: 'ghcr.io/radius-project/samples/demo:latest' + ports: { + web: { + containerPort: 3000 + } + } + } + } + } +} +``` + +Referencing `app.id` creates a symbolic dependency, so Radius creates the Application before the container. + +## Step 5: Choose the right Resource Type + +Model each part of your application with the Resource Type that best represents it. Radius ships with a set of [out-of-the-box Resource Types]({{< ref "/reference/resources" >}}) for compute, data, messaging, and more, and your platform team can publish [custom Resource Types]({{< ref "/extensibility/resource-types" >}}) for anything specific to your organization. + +- Browse the [Resource Types reference]({{< ref "/reference/resources" >}}) for each type's properties, API versions, and examples. +- List the types installed in your control plane with [`rad resource-type list`]({{< ref rad_resource-type_list >}}), or browse them in the [Radius Dashboard]({{< ref "/installation/dashboard" >}}). + +The Environment's [Recipe Packs]({{< ref "/concepts/recipe-packs" >}}) must contain a recipe for every Resource Type your definition uses. Without a matching recipe, the deployment fails because Radius does not know how to provision that resource. + +## Step 6: Parameterize the definition + +Use Bicep parameters for values that change between Environments or deployments, such as an image tag or a resource size. Parameters keep a single definition reusable across `dev`, `test`, and `prod`: + +```bicep +@description('Container image tag to deploy.') +param imageTag string = 'latest' + +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: app.id + containers: { + web: { + image: 'ghcr.io/radius-project/samples/demo:${imageTag}' + ports: { + web: { + containerPort: 3000 + } + } + } + } + } +} +``` + +Supply parameter values at deploy time with `--parameters`, or store them in a `.bicepparam` file. Keep the `environment` parameter as is; the Radius CLI supplies it automatically. + +## Next steps + +With the resources modeled, connect them together to model dependencies within the Application. + +{{< button text="Next step: How to model application dependencies using connections" page="/applications/connections" >}} diff --git a/docs/content/applications/deploy/_index.md b/docs/content/applications/deploy/_index.md new file mode 100644 index 000000000..6caef071c --- /dev/null +++ b/docs/content/applications/deploy/_index.md @@ -0,0 +1,149 @@ +--- +type: docs +title: "How to deploy applications using Radius" +linkTitle: "Deploy applications" +description: "Learn how to deploy and manage applications with Radius" +weight: 300 +aliases: + - /guides/applications/ +--- + +An [Application]({{< ref "/concepts/applications" >}}) in Radius groups the resources that make up an application and records the relationships between them. You define an Application and its resources in Bicep, then deploy the definition to a Radius Environment. + +## Step 1: Create an application definition + +Create a file named `app.bicep`. Import the Radius extension and declare an `environment` parameter. The Radius CLI supplies the selected Environment's resource ID when you deploy the file. + +Define a `Radius.Core/applications` resource, then add the resources that make up the Application. Set `environment` and `application` on each resource to associate it with the Application: + +```bicep +extension radius + +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string + +resource app 'Radius.Core/applications@2025-08-01-preview' = { + name: 'my-app' + properties: { + environment: environment + } +} + +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: app.id + containers: { + web: { + image: 'ghcr.io/radius-project/samples/demo:latest' + ports: { + web: { + containerPort: 3000 + } + } + } + } + } +} +``` + +Use any Resource Type installed in your Radius control plane. Review the [Resource Types reference]({{< ref "/reference/resources" >}}) for the available properties and examples. The Environment's Recipe Packs must contain a recipe for each Resource Type used by the Application. + +## Step 2: Deploy to an Environment + +Deploy the application definition to an Environment with [`rad deploy`]({{< ref rad_deploy >}}): + +```bash +rad deploy app.bicep +``` + +Radius compiles the Bicep file, supplies the Environment configured in the current Workspace through the `environment` parameter, and creates or updates the Application and its resources. + +Use `--environment` to deploy to a different Environment: + +```bash +rad deploy app.bicep --environment dev +``` + +After the deployment succeeds, inspect the Application graph: + +<!-- TODO: Remove the `--preview` flag when the Radius.Core Application implementation is no longer in preview. --> +```bash +rad application graph --application my-app --preview +``` + +The graph shows the Radius resources, infrastructure created by recipes, and relationships between resources. + +## Troubleshoot deployment errors + +Start with the error returned by `rad deploy`. Errors generally occur in one of three stages: + +- **Bicep compilation:** Correct Bicep syntax, resource type versions, property names, and parameter values. Use the [Resource Types reference]({{< ref "/reference/resources" >}}) to verify the schema. +- **Radius resource deployment:** Confirm that the target Environment exists and that every resource sets the expected `environment` and `application` properties. Inspect the Application with `rad application status` and `rad application graph`. +- **Recipe execution:** Confirm that the Environment uses a Recipe Pack containing a recipe for the failing Resource Type. Review the recipe source, parameters, cloud provider configuration, and credentials. + +Use JSON output when you need the complete resource details: + +<!-- TODO: Remove the `--preview` flag when the Radius.Core Application implementation is no longer in preview. --> +```bash +rad application status my-app --preview --output json +rad application graph --application my-app --preview --output json +``` + +If a recipe creates Kubernetes resources, inspect the target namespace for failed workloads and events: + +```bash +kubectl get pods --namespace <namespace> +kubectl get events --namespace <namespace> --sort-by=.lastTimestamp +``` + +The Kubernetes namespace is configured on the Environment and may differ from the Environment name. See [How to design and manage Environments]({{< ref "/management/environments" >}}) to inspect Environment configuration. + +## Prune removed resources + +Removing a resource declaration from `app.bicep` and deploying the file again does not delete the existing resource. This prevents an accidental deletion when a declaration is removed or renamed. + +After removing the declaration, deploy the updated Application: + +```bash +rad deploy app.bicep +``` + +List the resources that still belong to the Application: + +```bash +rad resource list --application my-app +``` + +Delete the removed resource by its Resource Type and name. For example, delete the `frontend` Container: + +```bash +rad resource delete Radius.Compute/containers frontend +``` + +The command prompts for confirmation, deletes the Radius resource, and runs its normal deletion lifecycle for infrastructure managed by that resource. + +Review the resource before confirming deletion. Deleting a database, message broker, or other stateful resource can permanently delete its managed infrastructure and data. + +Confirm that the removed resource no longer appears in the Application graph: + +<!-- TODO: Remove the `--preview` flag when the Radius.Core Application implementation is no longer in preview. --> +```bash +rad application graph --application my-app --preview +``` + +## Delete an Application + +Delete an Application when it and all of its owned resources are no longer needed: + +<!-- TODO: Remove the `--preview` flag when the Radius.Core Application implementation is no longer in preview. --> +```bash +rad application delete my-app --preview +``` + +The command prompts for confirmation. Radius finds resources whose `application` property references `my-app`, deletes them, and then deletes the Application resource. Resources that are shared with or connected to the Application but are not owned by it are not deleted. + +Deleting an Application can permanently delete managed infrastructure and data. Review the Application graph before confirming the operation. Use `--yes` to bypass confirmation in automation. + +Use `--force` only when the Application contains resources stuck in a non-terminal state. Force deletion can leave external infrastructure behind for manual cleanup. diff --git a/docs/content/community/_index.md b/docs/content/community/_index.md deleted file mode 100644 index 99ddef454..000000000 --- a/docs/content/community/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Radius Community" -linkTitle: "Community" -description: "Information about the Radius community" -weight: 120 ---- \ No newline at end of file diff --git a/docs/content/concepts/_index.md b/docs/content/concepts/_index.md index 2a6b1df14..d288dba2d 100644 --- a/docs/content/concepts/_index.md +++ b/docs/content/concepts/_index.md @@ -3,14 +3,14 @@ type: docs title: "Radius Concepts" linkTitle: "Concepts" description: "Radius core concepts and architecture" -weight: 20 +weight: 200 --- ## Introduction Radius is a platform for defining and deploying applications and infrastructure to any cloud. It is a central component of modern-day internal developer platforms (IDPs). It allows platform engineers to define resource types for developers to use when building their applications, and separately, the implementation of those resource types using existing Infrastructure as Code (IaC) templates and modules. Additionally, Radius enables platform engineers to define logical environments with specific deployment targets (e.g., a specific cloud provider region), each with their own IaC implementation. -This page provides a conceptual overview of Radius. It describes Radius' logical components, technical architecture and how Radius relates to other IDP components. It is accompanied by additional concept pages focused on each of the core components: Resource Types, Recipes, Environments, and Applications. If you are new to Radius, you are encouraged to complete the [Quick Start]({{< ref "quick-start" >}}). Then, after reading the concept documentation, complete the end-to-end [tutorial]({{< ref "tutorials" >}}). +This page provides a conceptual overview of Radius. It describes Radius' logical components, technical architecture, and how Radius relates to other IDP components. It is accompanied by additional concept pages focused on each of the core components: Resource Types, Recipe Packs, Environments, and Applications. If you are new to Radius, you are encouraged to complete the [Quick Start]({{< ref "quick-start" >}}). Then, after reading the concept documentation, complete the end-to-end [tutorial]({{< ref "tutorials" >}}). ## IDP reference architecture @@ -38,17 +38,19 @@ Radius is designed around a small number of core components. In order to enforce #### Resource Types -Resource Types define the abstraction for a resource that will exist in the real world when deployed. Resource Types represent the **interface**, or contract, between developers and the platform. Since they are abstract and application oriented, there is only one Resource Type defined within Radius for each application resource. For example, a platform engineer may define a PostgreSQL database Resource Type which is an application-oriented abstraction of a one of the many ways of deploying an PostgreSQL database. Resource Types are defined conceptually by what they represent, but concretely by their name, API version, and their schema. The schema contains the set of required and optional properties which are used by developers when defining their application. +Resource Types define the abstraction for a resource that will exist in the real world when deployed. Resource Types represent the **interface**, or contract, between developers and the platform. Since they are abstract and application oriented, there is only one Resource Type defined within Radius for each application resource. For example, a platform engineer may define a PostgreSQL database Resource Type which is an application-oriented abstraction of one of the many ways of deploying a PostgreSQL database. Resource Types are defined conceptually by what they represent, but concretely by their name, API version, and their schema. The schema contains the set of required and optional properties which are used by developers when defining their application. -#### Recipes +#### Recipe Packs -While Resource Types define the interface, Recipes define the resource deployment **implementation**. Radius supports deploying resources using either Terraform or Bicep. The term *recipe* is used as a generic term to refer to both a Terraform configuration or a Bicep template. +While Resource Types define the interface, Recipe Packs define the resource deployment **implementation**. A Recipe Pack is a simple manifest whose primary property is a set of recipes, one for each Resource Type. The term *recipe* is used as a generic term to refer to both a Terraform configuration or a Bicep template. For each Resource Type, the Recipe Pack specifies the Terraform configuration or Bicep template used to deploy that type, along with recipe parameter values that Radius will pass to the recipe at deploy-time. One or more Recipe Packs are then referenced in an Environment definition. -Recipes are not tightly coupled with Radius or the Resource Type. In most circumstances, an existing Terraform configuration or Bicep template can be used as a Recipe with slight modifications to ensure the properties in the Resource Type map to the Terraform variables or Bicep parameters. +Recipes are not tightly coupled with Radius or the Resource Type. In most circumstances, an existing Terraform configuration or Bicep template can be used as a recipe with slight modifications to ensure the properties in the Resource Type map to the Terraform variables or Bicep parameters. #### Environments -Environments are where Resource Types, Recipes, and cloud providers come together. An Environment defines where applications are deployed; i.e., a landing zone for applications. Specifically, a Kubernetes namespace, an AWS account and region, or an Azure subscription and resource group. Critically, the Environment also defines the set of Recipes to be used for each Resource Type. By assigning Recipes at the Environment level, it is possible for each Environment to have a unique set of Recipes. Finally, each Recipe in an Environment definition can also have Environment-level Recipe parameters. Recipe parameters are useful for injecting additional environmental information into the Recipe. +Environments are where Resource Types, Recipe Packs, and cloud providers come together. An Environment defines where applications are deployed; i.e., a landing zone for applications. Specifically, a Kubernetes namespace, an AWS account, region, and EKS cluster, or an Azure subscription, resource group, and AKS cluster. The Kubernetes cluster where the Radius control plane runs is independent of where application containers are deployed, so a single Radius installation can deploy applications to many different clusters. Critically, the Environment also defines which Recipe Packs are used to deploy resources. By assigning Recipe Packs at the Environment level, it is possible for each Environment to have a unique set of recipes. + +Finally, within the Environment definition, Environment-level recipe parameters can be defined. Recipe parameters are useful for injecting additional environmental information into the recipe such as if the environment is production or non-production. These parameters will override parameters defined within the Recipe Pack. #### Resource Groups @@ -62,9 +64,9 @@ When a developer requests a resource to be deployed, those resources are not dep #### Applications and resources -Developers build applications. But when they deploy those applications to Kubernetes or other container platforms, the notion of an application is typically lost. Developers are left with essentially a flat list of resources. In the best case, the resources are annotated with the application name, but not always. This makes it challenging for developers and SREs to understand what resources belong to what applications. +Developers build applications. But when they deploy those applications to Kubernetes or other container platforms, the notion of an application is typically lost. Developers are left with essentially a flat list of resources. In the best case, the resources are annotated with the application name, but not always. This makes it challenging for developers and SREs to understand what resources belong to what applications. -Radius takes a different approach and makes the application a first-class resource. With Radius, developers first define an Application resource, then add resources to that Application such as containers and databases. All resources belong to an Application (with some exceptions for resources shared across applications such as shared storage). When an Application is deployed to an Environment, the Application's abstract resource definitions are *implemented* by the platform-specific Recipes in the Environment. +Radius takes a different approach and makes the application a first-class resource. With Radius, developers first define an Application resource, then add resources to that Application such as containers and databases. All resources belong to an Application (with some exceptions for resources shared across applications such as shared storage). When an Application is deployed to an Environment, the Application's abstract resource definitions are *implemented* by the platform-specific recipes in the Recipe Packs assigned to the Environment. ## Technical architecture @@ -100,8 +102,10 @@ The Controller component is an internal component that handles miscellaneous fun ### Git repository and OCI registry -When Radius deploys a resource using Terraform or Bicep, the Applications and Dynamic RP container must have access to the specified Recipe. Therefore, a Git repository is used to store Terraform configurations and an OCI registry is used to store Bicep templates. Radius does not run Recipes off the local workstation's file system. +When Radius deploys a resource using Terraform or Bicep, the Applications and Dynamic RP container must have access to the specified recipe. Therefore, a Git repository is used to store Terraform configurations and an OCI registry is used to store Bicep templates. Radius does not run recipes off the local workstation's file system. + +## Organization -## Next Steps +The concept documentation is organized into four sequential pages, each covering one of the core Radius components: Resource Types, Recipe Packs, Environments, and Applications. Read them in order for a complete conceptual overview. If you prefer to be hands-on, skip forward to the [tutorial]({{< ref "tutorials" >}}). -If you want to learn more about Radius concepts, continue reading the additional concept pages below. However, if you prefer to be hands-on, skip forward to the [tutorial]({{< ref "tutorials" >}}). \ No newline at end of file +{{< button text="Next step: Read about Resource Types" page="concepts/resource-types" >}} \ No newline at end of file diff --git a/docs/content/concepts/applications/index.md b/docs/content/concepts/applications/index.md index 6a32bec13..69ec4c046 100644 --- a/docs/content/concepts/applications/index.md +++ b/docs/content/concepts/applications/index.md @@ -3,9 +3,9 @@ type: docs title: "Applications Concepts" linkTitle: "Applications" description: "How Radius manages applications" -weight: 40 +weight: 400 aliases: - - /content/guides/author-apps/applications/overview + - /content/guides/applications/applications/overview --- A Radius Application is a resource that is a parent to other resources that make up the application. Applications and its resources are defined in an application definition file using the Bicep Infrastructure as Code (IaC) language. Since applications are a first-class Resource Type in Radius, developers perform operations on applications rather than individual resources. When deploying resources, developers simply deploy the Application. Radius also tracks all deployed resources and their dependencies in a graph. Developers can add to the graph by expressing explicit dependencies such as a container relying on a database. diff --git a/docs/content/concepts/environments/index.md b/docs/content/concepts/environments/index.md index 2988962c9..9c66103d9 100644 --- a/docs/content/concepts/environments/index.md +++ b/docs/content/concepts/environments/index.md @@ -3,27 +3,29 @@ type: docs title: "Environments Concepts" linkTitle: "Environments" description: "How Environments define how and where resources are deployed" -weight: 30 +weight: 300 aliases: - - /content/guides/deploy-apps/environments/overview + - /content/guides/environments/environments/howto-environment/overview --- -All resources are deployed to an Environment. Environments define the deployment location as well as the set of Recipes to use to deploy resources to that Environment. The first component of an Environment definition is the deployment location, specified by `provider` property: +All resources are deployed to an Environment. Environments define the deployment location as well as the set of Recipe Packs to use to deploy resources to that Environment. The first component of an Environment definition is the deployment location, specified by `provider` property: - **Kubernetes**: The namespace -- **AWS**: The account and region -- **Azure**: The subscription and resource group +- **AWS**: The account, region, and EKS cluster name +- **Azure**: The subscription, resource group, and AKS cluster name + +For AWS and Azure, the named EKS or AKS cluster is the target cluster where application workloads are deployed. The Kubernetes cluster where the Radius control plane runs is independent of where application containers are deployed, so a single Radius installation can deploy applications to many different clusters. When a resource is deployed, these location details are provided to the Terraform configuration or Bicep template via the `context` object. -The second component is the set of Recipes for each Resource Type. By assigning Recipes at the Environment level, it is possible for each Environment to have a unique set of Recipes. Take a PostgreSQL database Resource Type as an example. There may be: +The second component is the set of Recipe Packs, which define the recipe for each Resource Type. By assigning Recipe Packs at the Environment level, it is possible for each Environment to have a unique set of recipes. Take a PostgreSQL database Resource Type as an example. There may be: - A development environment running on a local workstation that deploys the database to a local Kind or k3d cluster - A test environment which deploys to a shared Kubernetes cluster but also assigns more CPU and memory to the database - A staging environment that deploys the database to AWS using RDS - A production environment that also uses AWS RDS but configures the database with high availability and backups -Finally, each Recipe in an Environment definition can also have Environment-level Recipe parameters. Recipe parameters are useful for injecting additional environmental information into the Recipe. Take, for example, a Recipe which deploys a PostgreSQL database using AWS RDS or Azure Database for PostgreSQL. Ideally, the database is created with an endpoint in an existing VPC/virtual network. The virtual network ID can be passed to the Recipe via a Recipe parameter defined within the Environment. +Finally, an Environment definition can set Environment-level recipe parameters. These parameters override the parameter values defined in the Recipe Pack and are useful for injecting additional environmental information into the recipe. Take, for example, a recipe which deploys a PostgreSQL database using AWS RDS or Azure Database for PostgreSQL. Ideally, the database is created with an endpoint in an existing VPC/virtual network. The virtual network ID can be passed to the recipe via a recipe parameter defined within the Environment. ## Example of using Environments @@ -37,11 +39,11 @@ This approach is simple and easy to get started. However, as the number of appli {{< image src="environments-apps.png" alt="Application-centric environment layout" >}} -This layout has the advantage of having the ability to customize Recipes per application. However as the number of applications increases, so do the number of Environments which just make for a more complex platform. The final, most advanced layout, represents a large enterprise with multiple business units. +This layout has the advantage of having the ability to customize Recipe Packs per application. However as the number of applications increases, so do the number of Environments which just make for a more complex platform. The final, most advanced layout, represents a large enterprise with multiple business units. {{< image src="environments-enterprise.png" alt="Enterprise environment layout" >}} Here, Environments are organized by business units, cloud regions, and production versus non-production environments. <br> -{{< button text="Next step: Read about Applications concepts" page="concepts/applications" >}} +{{< button text="Next step: Read about Applications" page="concepts/applications" >}} diff --git a/docs/content/concepts/recipe-packs/context.png b/docs/content/concepts/recipe-packs/context.png new file mode 100644 index 000000000..d4b641bb4 Binary files /dev/null and b/docs/content/concepts/recipe-packs/context.png differ diff --git a/docs/content/concepts/recipe-packs/default-recipe-pack.png b/docs/content/concepts/recipe-packs/default-recipe-pack.png new file mode 100644 index 000000000..aa3db5488 Binary files /dev/null and b/docs/content/concepts/recipe-packs/default-recipe-pack.png differ diff --git a/docs/content/concepts/recipe-packs/index.md b/docs/content/concepts/recipe-packs/index.md new file mode 100644 index 000000000..b28bd273e --- /dev/null +++ b/docs/content/concepts/recipe-packs/index.md @@ -0,0 +1,85 @@ +--- +type: docs +title: "Recipe Pack Concepts" +linkTitle: "Recipe Packs" +description: "How Recipe Packs are used to deploy resources" +weight: 200 +aliases: + - /content/guides/recipes/overview/ +--- + +Recipe Packs define how resources are deployed in Radius. While a Resource Type defines the interface used to request a resource, a Recipe Pack defines the implementation: the Terraform configuration or Bicep template that is called to perform a deployment and the parameters passed to the recipe. + +## What is a Recipe Pack? + +While Resource Types are abstract and application oriented, a Recipe Pack is concrete and cloud provider-specific. It maps each Resource Type to the recipe that provisions it. Changing the Recipe Pack changes how resources are deployed without changing the applications that use them. + +Because deployments only happen through a Recipe Pack, Recipe Packs are also how a platform enforces security, operational, and cost best practices. A resource is requested by its Resource Type, and the approved Recipe Pack determines how that resource is actually created. + +The term *recipe* is used because Radius uses existing Infrastructure as Code (IaC) solutions to perform the actual deployment. Today, Radius supports both Terraform and Bicep, and is designed to integrate with other IaC solutions in the future. As long as there is a Terraform provider or Bicep extension, Radius can deploy the resource. In most cases an existing Terraform configuration or Bicep template can be used as a recipe with only minor changes. + +For each Resource Type, a Recipe Pack defines: + +- **The recipe kind**: The IaC language used to deploy the resource, either Bicep or Terraform. +- **The recipe source**: Where the recipe is stored, such as an OCI registry for a Bicep template or a module source for a Terraform configuration. +- **Recipe parameters**: Optional parameter values that Radius passes to the recipe when a resource is deployed. + +A single Recipe Pack can contain recipes for many Resource Types, so one Recipe Pack can describe how to deploy databases, caches, message queues, and any other Resource Type the platform supports. + +When Radius is installed a `default` Recipe Pack is created: + +{{< image src="default-recipe-pack.png" width="50%" alt="Default recipe pack" >}} + +## How Recipe Packs relate to Environments + +Recipe Packs are separate resources from Environments, and the two are connected by reference. An Environment lists the Recipe Packs it uses. This enables a single Recipe Pack to serve the development, staging, and production Environments at the same time. + +{{< image src="recipe-pack-envs.png" width="80%" alt="Environments and recipe packs" >}} + +<br>An Environment can reference more than one Recipe Pack. When multiple Recipe Packs are referenced, the aggregate set of Resource Types across those Recipe Packs must be unique, so no two Recipe Packs define a recipe for the same Resource Type. + +## Recipe parameters + +Recipe parameters customize how a recipe behaves without changing the recipe itself. They are set at two levels: + +- **Recipe Pack parameters**: Defined in the Recipe Pack and applied to every Environment that references it. These act as defaults, such as a standard database version or a common set of tags. For example, the recipe for the `Radius.Compute/routes` Resource Type needs the name of the Kubernetes gateway controller. Setting this parameter in the Recipe Pack ensures every route uses the same gateway controller regardless of which Environment references the Recipe Pack. +- **Environment parameters**: Defined in the Environment and applied only to that Environment. These capture per-environment differences such as instance size, region, or credentials. For example, a production Environment can set a parameter indicating the environment type (such as `prod` versus `non-prod`) that is passed to a database recipe. The recipe can then enable high availability and automated backups only when the parameter indicates a production Environment. + +When a parameter is set in both places, the value defined on the Environment overrides the value defined in the Recipe Pack. This is what allows a single Recipe Pack to be reused across many Environments while still producing appropriately configured infrastructure in each one. + +## How recipes are executed + +Recipes can be new or existing Terraform configurations or Bicep templates. When a resource is deployed via Radius, the Radius control plane (specifically the Application RP) uses the Environment to find the Recipe Packs it references, then locates the Recipe for the requested Resource Type within those Recipe Packs. It then executes the Terraform or Bicep binary within the Application RP container and passes the Recipe location as a command-line argument. + +When executing the Terraform or Bicep binaries, Radius does several things: + +1. Performs `terraform init` if needed and sets up a Terraform backend. +1. Sets up authentication to OCI registries where Bicep templates are stored using the `bicepSettings` property on the Environment. +1. Sets up authentication to Git repositories where Terraform configurations are stored using the `terraformSettings` property on the Environment. +1. Sets environment variables with AWS and Azure credentials. These are well-known environment variables used by AWS and Azure Terraform providers and Bicep. +1. Passes in a Terraform variable or Bicep parameter called `context` which is discussed in detail below. +1. Passes in the Recipe parameters as Terraform variables or Bicep parameters, combining the defaults defined in the Recipe Pack with any overrides set on the Environment. +1. Reads the `result` output and updates the resource in Radius (also discussed below). + +## Recipe context object + +Radius automatically injects a `context` object when deploying resources. The `context` object is rich with *contextual* information about the Environment, Application, and the resource being deployed. This includes: + +- The Application name +- The Environment name as well as Kubernetes, AWS, and Azure details +- Recipe parameters from the Recipe Pack and the Environment +- The resource name and all of its properties +- All connected resources and their properties + +In addition to `context`, Recipe parameters are passed to the recipe. These parameters come from the Recipe Pack and the Environment, with Environment values overriding Recipe Pack defaults, and are set as Terraform variables or Bicep parameters. + +{{< image src="context.png" width="70%" alt="Recipe context sources" >}} + +By using the `context` object and Recipe parameters, Recipes have all the information needed to deploy the actual resource in the target location. This significantly reduces the amount of information needed when defining an application. + +## Recipe outputs + +Once the Recipe has been executed, Radius looks for a `result` output. The `result` output should contain output values for each of the read-only properties defined in the Resource Type so that Radius can set the read-only properties for use in the application definition. The `result` output should also include the resources created so Radius can track dependencies and manage deletions. + +<br> +{{< button text="Next step: Read about Environments" page="concepts/environments" >}} diff --git a/docs/content/concepts/recipe-packs/recipe-pack-envs.png b/docs/content/concepts/recipe-packs/recipe-pack-envs.png new file mode 100644 index 000000000..8eed1a425 Binary files /dev/null and b/docs/content/concepts/recipe-packs/recipe-pack-envs.png differ diff --git a/docs/content/concepts/recipes/context.png b/docs/content/concepts/recipes/context.png deleted file mode 100644 index 75b51d236..000000000 Binary files a/docs/content/concepts/recipes/context.png and /dev/null differ diff --git a/docs/content/concepts/recipes/index.md b/docs/content/concepts/recipes/index.md deleted file mode 100644 index 040342d9f..000000000 --- a/docs/content/concepts/recipes/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -type: docs -title: "Recipes Concepts" -linkTitle: "Recipes" -description: "How Recipes are used to deploy resources" -weight: 20 -aliases: - - /content/guides/recipes/overview/ ---- - -Recipes are how resources are deployed. The generic term *recipe* is used because Radius uses existing Infrastructure as Code (IaC) solutions to perform the actual deployment of resources. Today, Radius supports deploying resources using both Terraform and Bicep, but Radius is designed to integrate with other IaC solutions in the future. Just as Resource Types can represent any resource, Recipes can deploy any resource supported by the IaC language. As long as there is a Terraform provider or Bicep extension, Radius can deploy that resource. In fact, if you have an existing Terraform configurations or Bicep templates, they can be used as Recipes with only minor changes. - -The combination of Resource Types and Recipes remove the need for developers to have deep understanding of infrastructure they are deploying too. Additionally, Recipes enable platform engineers to enforce security, operational, and cost best practices by requiring resource deployments to be performed only via a configured Recipe. - -## How Recipes are executed - -Recipes can be any new or existing Terraform configurations or Bicep template. When a resource is deployed via Radius, the Radius control plane (specifically the Application RP) cross-references the Resource Type and Environment to determine which Recipe to execute. It then executes the Terraform or Bicep binary within the Application RP container and passes the Recipe location as a command-line argument. - -When executing the Terraform or Bicep binaries, Radius does several things: - -1. Performs `terraform init` if needed and sets up a Terraform backend using a Kubernetes secret. -1. Sets up authentication to OCI registries where Bicep templates are stored using properties stored in the Environment resource. -1. Sets up authentication to Git repositories where Terraform configurations are stored using properties stored in the Environment resource. -1. Sets environment variables with AWS and Azure credentials. These are well-know environment variables used by AWS and Azure Terraform providers and Bicep. -1. Passes in a Terraform variable or Bicep parameter called `context` which is discussed in detail below. -1. Passes in any Recipe parameters set on the Environment as a Terraform variable or Bicep parameter. -1. Reads the `result` output and updates the resource in Radius (also discussed below). - -## Recipe context object and Recipe parameters - -Radius automatically injects a `context` object when deploying resources. The `context` object is rich with *contextual* information about the Environment, Application, and the resource being deployed. This includes: - -- The Application name -- The Environment name as well as Kubernetes, AWS, and Azure details -- Parameters specified in the Environment definition -- The resource name and all of its properties -- All connected resources and their properties - -In addition to `context`, platform engineers can specify Recipe parameters in the Environment definition. These Recipe parameters are then set as Terraform variables or Bicep parameters. - -{{< image src="context.png" width="70%" alt="Recipe context sources" >}} - -By using the `context` object and Recipe parameters, Recipes have all the information needed to deploy the actual resource in the target location. this significantly reduces the amount of information needed from developers. - -## Recipe outputs - -Once the Recipe has been executed, Radius looks for a `result` output. The `result` output should contain output values for each of the read-only properties defined in the Resource Type so that Radius can set the read-only properties for use in the application definition. The `result` output should also include the resources created so Radius can track dependencies and manage deletions. - -<br> -{{< button text="Next step: Read about Environments concepts" page="concepts/environments" >}} diff --git a/docs/content/concepts/resource-types/index.md b/docs/content/concepts/resource-types/index.md index db8116e91..865a022d3 100644 --- a/docs/content/concepts/resource-types/index.md +++ b/docs/content/concepts/resource-types/index.md @@ -3,7 +3,7 @@ type: docs title: "Resource Types Concepts" linkTitle: "Resource Types" description: "How Resource Types abstract deployed resources" -weight: 10 +weight: 100 --- Radius Resource Types are the building blocks of Radius. They represent the various types of resources that developers use to build their applications. Radius ships with a number of common Resource Types including containers, secrets, and various databases. But the power of Resource Types is that they can model anything that can be deployed with Infrastructure as Code (IaC). A Resource Type can be a low-level application component such as a log collector or a high-level, abstract component such as a web service. This page goes into more depth on the concept of Resource Types. @@ -36,9 +36,9 @@ A Resource Type is defined in a Resource Type definition YAML file with four com Resource Types are defined in YAML files. Below is an example of a simple PostgreSQL database Resource Type. The description properties have been omitted for brevity. The `environment` property defines which Environment the resource is deployed to. However, in practice, this property is set by the Radius CLI when a developer runs `rad deploy`. The `application` property is typically set in the application definition Bicep file. -Notice that the `host`, `port`, `username`, and `passwordSecretRef` properties are read only. These are properties set the Recipe after the resource has been deployed. +Notice that the `host`, `port`, `username`, and `passwordSecretRef` properties are read only. These properties are set by the recipe after the resource has been deployed. {{< image src="postgreSqlDatabases.png" alt="PostgreSQL Resource Type YAML" >}} <br><br> -{{< button text="Next step: Read about Recipes concepts" page="concepts/recipes" >}} +{{< button text="Next step: Read about Recipe Packs" page="concepts/recipe-packs" >}} diff --git a/docs/content/contributing/_index.md b/docs/content/contributing/_index.md index 9de6f74b3..70dc3a1c7 100644 --- a/docs/content/contributing/_index.md +++ b/docs/content/contributing/_index.md @@ -3,5 +3,5 @@ type: docs title: "Contributing to Radius" linkTitle: "Contributing" description: "Guides and requirements for contributing to Radius" -weight: 110 +weight: 1000 --- \ No newline at end of file diff --git a/docs/content/community/overview/index.md b/docs/content/contributing/community/index.md similarity index 98% rename from docs/content/community/overview/index.md rename to docs/content/contributing/community/index.md index fef8e1bfa..b18492a67 100644 --- a/docs/content/community/overview/index.md +++ b/docs/content/contributing/community/index.md @@ -1,7 +1,7 @@ --- type: docs title: "Radius Community" -linkTitle: "Overview" +linkTitle: "Community" description: "Information about the Radius community" weight: 100 --- diff --git a/docs/content/community/media-coverage/index.md b/docs/content/contributing/media-coverage/index.md similarity index 100% rename from docs/content/community/media-coverage/index.md rename to docs/content/contributing/media-coverage/index.md diff --git a/docs/content/contributing/presentations/index.md b/docs/content/contributing/presentations/index.md index f2f3c830c..1b9bdfeed 100644 --- a/docs/content/contributing/presentations/index.md +++ b/docs/content/contributing/presentations/index.md @@ -29,7 +29,7 @@ We offer a template PowerPoint file to get started: ### Preparing the demo -1. Use the Radius [tutorial]({{< ref tutorial >}}) and [samples repo](https://github.com/radius-project/samples) to show demos of how to use Radius. +1. Use the Radius [tutorial]({{< ref tutorials >}}) and [samples repo](https://github.com/radius-project/samples) to show demos of how to use Radius. ## Other resources diff --git a/docs/content/extensibility/_index.md b/docs/content/extensibility/_index.md new file mode 100644 index 000000000..4897b638b --- /dev/null +++ b/docs/content/extensibility/_index.md @@ -0,0 +1,9 @@ +--- +type: docs +title: "Extend Radius" +linkTitle: "Extend Radius" +description: "Create custom Resource Types and Recipes, and manage Recipe Packs" +weight: 700 +--- + +Extend Radius with custom Resource Types and Recipes, then organize and distribute Recipes with Recipe Packs. diff --git a/docs/content/extensibility/recipe-packs/_index.md b/docs/content/extensibility/recipe-packs/_index.md new file mode 100644 index 000000000..da76ddd8c --- /dev/null +++ b/docs/content/extensibility/recipe-packs/_index.md @@ -0,0 +1,108 @@ +--- +type: docs +title: "How to manage Recipe Packs" +linkTitle: "Manage Recipe Packs" +description: "Learn how to create, assign, update, and manage Recipe Packs" +weight: 300 +aliases: + - /guides/recipe-packs/ +--- + +A [Recipe Pack]({{< ref "/concepts/recipe-packs" >}}) is a Radius resource that groups recipes by Resource Type. Platform engineers create Recipe Packs in the Radius control plane and assign them to Environments to control how Radius provisions infrastructure. + +This guide focuses on managing the Recipe Pack resource after its recipes have been authored and published. To create and publish a recipe, see [How to use custom recipes with Radius]({{< ref "/extensibility/recipes" >}}). + +## Step 1: Create a Recipe Pack + +Define the Recipe Pack in a file named `recipe-pack.bicep`. Each key in `recipes` is the Resource Type that the recipe provisions. Set `kind` to `bicep` or `terraform`, and set `source` to the published recipe location: + +```bicep +extension radius + +resource dataRecipes 'Radius.Core/recipePacks@2025-08-01-preview' = { + name: 'data-recipes' + properties: { + recipes: { + 'Radius.Data/redisCaches': { + kind: 'bicep' + source: 'ghcr.io/my-org/recipes/redis:v1.1.0' + parameters: { + sku: 'development' + } + } + 'Radius.Data/postgreSqlDatabases': { + kind: 'terraform' + source: 'git::https://github.com/my-org/recipes.git//postgresql?ref=v1.2.0' + } + } + } +} +``` + +Deploy the file to create the Recipe Pack: + +```bash +rad deploy recipe-pack.bicep +``` + +`rad deploy` creates the Recipe Pack when it does not exist and updates it when it already exists. + +Confirm that the Recipe Pack exists: + +```bash +rad recipe-pack show data-recipes +``` + +To list Recipe Packs in a Resource Group, run: + +```bash +rad recipe-pack list --group default +``` + +## Step 2: Assign the Recipe Pack to an Environment + +Use [`rad environment update`]({{< ref rad_environment_update >}}) to replace an Environment's Recipe Pack list. The following command configures the `default` Environment to use `data-recipes`: + +<!-- TODO: Remove the `--preview` flag when the Radius.Core Environment implementation is no longer in preview. --> +```bash +rad environment update default \ + --recipe-packs data-recipes \ + --preview +``` + +An Environment stores an array of Recipe Pack references. You can assign more than one Recipe Pack by passing a comma-separated list: + +<!-- TODO: Remove the `--preview` flag when the Radius.Core Environment implementation is no longer in preview. --> +```bash +rad environment update default \ + --recipe-packs data-recipes,compute-recipes \ + --preview +``` + +Each Resource Type can have only one recipe across all Recipe Packs assigned to an Environment. For example, `data-recipes` can provide a recipe for `Radius.Data/redisCaches` while `compute-recipes` provides one for `Radius.Compute/containers`. The two packs cannot both provide a recipe for `Radius.Data/redisCaches`, because Radius would not know which recipe to use. + +The `--recipe-packs` option replaces the Environment's complete Recipe Pack list; it does not append to the existing list. Include every Recipe Pack that the Environment should continue to use each time you run the command. To assign a Recipe Pack stored in a different Resource Group, see [Reference a Recipe Pack across Resource Groups]({{< ref "/management/environments#reference-a-recipe-pack-across-resource-groups" >}}). + +## Step 3: Update a Recipe Pack + +Edit `recipe-pack.bicep`, then deploy it again: + +```bash +rad deploy recipe-pack.bicep +``` + +Keep the Recipe Pack name stable so existing Environment references remain valid. Before changing a recipe source, parameters, or outputs, review every Environment that references the pack. The change affects subsequent deployments of that Resource Type in those Environments. + +Prefer publishing a new immutable recipe version and updating the `source` property to that version. Test the updated pack in a non-production Environment before using it in production. + +## Step 4: Delete a Recipe Pack + +Delete the Recipe Pack from the Radius control plane: + +```bash +rad recipe-pack delete data-recipes +``` + +The command prompts for confirmation, removes the Recipe Pack from every Environment that references it, and then deletes the Recipe Pack. If Radius cannot update one of those Environments, the command returns an error and does not delete the Recipe Pack. + +Use `--yes` only in automation where the deletion has already been validated. diff --git a/docs/content/extensibility/recipes/_index.md b/docs/content/extensibility/recipes/_index.md new file mode 100644 index 000000000..0ba638d76 --- /dev/null +++ b/docs/content/extensibility/recipes/_index.md @@ -0,0 +1,264 @@ +--- +type: docs +title: "How to create a custom recipe with Radius" +linkTitle: "Create custom Recipes" +description: "Learn how to use Terraform and Bicep recipes with Radius" +weight: 200 +aliases: + - /guides/recipes/ + - /guides/recipes/howto-author-recipes/ + - /tutorials/create-recipe/ +--- + +A [recipe]({{< ref "/concepts/recipe-packs" >}}) is a Terraform module or Bicep template that defines how Radius provisions infrastructure for a Resource Type. You can use existing infrastructure-as-code with Radius by accepting the Radius `context` object and, when needed, returning a `result` object. + +This guide shows you how to adapt a Terraform module or Bicep template to run as a Radius recipe. It focuses on using `context` to make Radius resource, application, Environment, runtime, connection, and cloud provider information available within the recipe. It also explains how to use `result` to return information to Radius. Adding the recipe to a Recipe Pack and assigning that Recipe Pack to an Environment are covered separately. + +## Use community recipes as examples + +The [`radius-project/resource-types-contrib`](https://github.com/radius-project/resource-types-contrib) repository is the community-maintained source for Resource Types and recipes that ship with Radius. Each Resource Type directory contains implementations for supported deployment targets, making the repository a useful source of complete Terraform and Bicep examples. + +Before starting from an empty module, look for a Resource Type with similar infrastructure or provider requirements. You can adapt an existing recipe for your organization or follow the [contribution guide](https://github.com/radius-project/resource-types-contrib/blob/main/docs/contributing/contributing-resource-types-recipes.md) to propose a Resource Type and recipe for the community library. + +## Step 1: Use the recipe context + +Radius injects a `context` object every time it runs a recipe. Declaring `context` as an input enriches an existing Terraform module or Bicep template with information managed by Radius. Use that information to read resource properties and connections, generate stable resource names, select deployment details such as the Kubernetes namespace, and access configured cloud provider scopes. + +Names should be both unique and repeatable: running the recipe again for the same Radius resource should target the same infrastructure, while two different Radius resources should not collide. + +{{< tabs Terraform Bicep >}} + +{{% codetab %}} + +```terraform +variable "context" { + description = "Radius-provided information about the resource and its Environment." + type = any +} + +locals { + resource_name = "redis-${substr(sha256(var.context.resource.id), 0, 8)}" + namespace = var.context.runtime.kubernetes.namespace +} +``` + +{{% /codetab %}} + +{{% codetab %}} + +```bicep +@description('Radius-provided information about the resource and its Environment.') +param context object + +var resourceName = 'redis-${uniqueString(context.resource.id)}' +var namespace = context.runtime.kubernetes.namespace +``` + +{{% /codetab %}} + +{{< /tabs >}} + +The context also exposes application and Environment metadata, resource connections, and configured cloud provider scopes. See the [recipe context reference]({{< ref "/reference/recipes/context" >}}) for its complete schema and examples. + +## Step 2: Declare providers and extensions + +Create a Terraform module or Bicep template that provisions the infrastructure backing your Resource Type. Declare any providers or extensions required by that infrastructure. + +{{< tabs Terraform Bicep >}} + +{{% codetab %}} + +Create a Terraform module with files such as `main.tf`, `variables.tf`, and `outputs.tf`. Declare every provider the module uses so Radius can supply the appropriate provider configuration when the recipe runs: + +```terraform +terraform { + required_providers { + kubernetes = { + source = "hashicorp/kubernetes" + version = ">= 2.0" + } + } +} +``` + +{{% /codetab %}} + +{{% codetab %}} + +Create a Bicep template such as `recipe.bicep`. For example, import the Kubernetes extension when the recipe deploys Kubernetes resources: + +```bicep +extension kubernetes with { + kubeConfig: '' + namespace: context.runtime.kubernetes.namespace +} +``` + +The Kubernetes extension for Bicep requires the Kubernetes namespace to be set when adding the extension to the template. `context.runtime.kubernetes.namespace` is used. This parameter is sourced from the `properties.providers.kubernetes.namespace` on the `Radius.Core/environments` resource. + +{{% /codetab %}} + +{{< /tabs >}} + +## Step 3: Add recipe parameters + +Declare inputs for settings that should be configurable without changing the recipe source. These can include an image version, SKU, capacity, or other operational settings. Give parameters safe defaults when an appropriate default exists. + +{{< tabs Terraform Bicep >}} + +{{% codetab %}} + +```terraform +variable "port" { + description = "The port Redis listens on." + type = number + default = 6379 +} +``` + +{{% /codetab %}} + +{{% codetab %}} + +```bicep +@description('The port Redis listens on.') +param port int = 6379 +``` + +{{% /codetab %}} + +{{< /tabs >}} + +Use these inputs in the resources your module or template creates. Recipe Pack authors can later provide default values, and Environment authors can override them for a Resource Type. + +## Step 4: Return the recipe result + +After provisioning infrastructure, a recipe can return a special output named `result`. Use its three supported properties to report the outcome to Radius: + +- `values` contains non-sensitive computed properties such as a host and port. +- `secrets` contains sensitive values such as credentials or connection strings. +- `resources` contains resource IDs that Radius should track and delete with the Radius resource. + +The properties returned by the recipe should match the properties defined by the Resource Type. Radius automatically tracks Azure Resource Manager and UCP resources created by Bicep. Return IDs for resources Radius cannot discover automatically, including Kubernetes resources. + +{{< tabs Terraform Bicep >}} + +{{% codetab %}} + +Terraform requires a `result` that contains secrets to be marked sensitive: + +```terraform +output "result" { + value = { + values = { + host = "${kubernetes_service.redis.metadata[0].name}.${kubernetes_service.redis.metadata[0].namespace}.svc.cluster.local" + port = kubernetes_service.redis.spec[0].port[0].port + } + secrets = { + password = random_password.redis.result + } + resources = [ + "/planes/kubernetes/local/namespaces/${kubernetes_service.redis.metadata[0].namespace}/providers/core/Service/${kubernetes_service.redis.metadata[0].name}" + ] + } + sensitive = true +} +``` + +{{% /codetab %}} + +{{% codetab %}} + +```bicep +output result object = { + values: { + host: '${redisService.metadata.name}.${redisService.metadata.namespace}.svc.cluster.local' + port: redisService.spec.ports[0].port + } + secrets: { + #disable-next-line outputs-should-not-contain-secrets + password: password + } + resources: [ + '/planes/kubernetes/local/namespaces/${redisService.metadata.namespace}/providers/core/Service/${redisService.metadata.name}' + ] +} +``` + +{{% /codetab %}} + +{{< /tabs >}} + +The `result` output is optional when a recipe has no computed properties or secrets and creates only resources that Radius tracks automatically. See the [recipe result reference]({{< ref "/reference/recipes/result" >}}) for the complete contract and examples. + +## Step 5: Validate the recipe + +Format and validate the recipe before publishing it. Validation catches syntax errors and missing provider or extension declarations, but it cannot verify every value supplied through the Radius context. + +{{< tabs Terraform Bicep >}} + +{{% codetab %}} + +Run Terraform formatting and validation from the module directory: + +```bash +terraform fmt -check +terraform init -backend=false +terraform validate +``` + +{{% /codetab %}} + +{{% codetab %}} + +Compile the Bicep template: + +```bash +bicep build recipe.bicep +``` + +{{% /codetab %}} + +{{< /tabs >}} + +## Step 6: Store the recipe + +After validating the recipe, publish it to a source that the Radius control plane can reach. Use an immutable version and avoid references such as an unversioned branch or `latest` tag for production Recipe Packs. + +{{< tabs Terraform Bicep >}} + +{{% codetab %}} + +Store a Terraform recipe in a Git repository or publish it as a module in a Terraform registry. A versioned Git module source can select a subdirectory and tag: + +```text +git::https://github.com/my-org/recipes.git//redis/terraform?ref=v1.1.0 +``` + +Follow the [Terraform module publishing guidance](https://developer.hashicorp.com/terraform/registry/modules/publish) when using a Terraform registry. + +{{% /codetab %}} + +{{% codetab %}} + +Publish a Bicep recipe to an OCI-compliant registry with [`rad bicep publish`]({{< ref rad_bicep_publish >}}): + +```bash +rad bicep publish \ + --file recipe.bicep \ + --target br:ghcr.io/my-org/recipes/redis:v1.1.0 +``` + +{{% /codetab %}} + +{{< /tabs >}} + +If the recipe is stored in a private registry, configure the appropriate TerraformSettings or BicepSettings on the Environment. See [How to design and manage Environments]({{< ref "/management/environments#configure-terraformsettings-and-bicepsettings" >}}) for the available authentication and engine settings. + +The Terraform module or Bicep artifact is now ready to be referenced from a Recipe Pack. + +## Next steps + +Now that you have created a new recipe, it must be added to a Recipe Pack which is assigned to an Environment. + +{{< button text="Next step: How to manage Recipe Packs" page="/extensibility/recipe-packs" >}} diff --git a/docs/content/extensibility/resource-types/_index.md b/docs/content/extensibility/resource-types/_index.md new file mode 100644 index 000000000..c85af3994 --- /dev/null +++ b/docs/content/extensibility/resource-types/_index.md @@ -0,0 +1,127 @@ +--- +type: docs +title: "How to create custom Resource Types" +linkTitle: "Create custom Resource Types" +description: "Learn how to create a custom Resource Type in Radius" +weight: 100 +aliases: + - /guides/resource-types/ +--- + +[Resource Types]({{< ref "concepts/resource-types" >}}) define the resources developers use to model an application. A Resource Type specifies the properties developers provide, the values Radius returns, and the API versions available for that resource. + +Use a custom Resource Type when the [out-of-the-box Resource Types]({{< ref "/reference/resources" >}}) do not model what your developers need. This guide explains how to design the type, define its schema and provisioning behavior, register it with Radius, and make it available to Bicep authors. + +## Use community Resource Types as examples + +The [`radius-project/resource-types-contrib`](https://github.com/radius-project/resource-types-contrib) repository is the community-maintained source for Resource Types and recipes that ship with Radius. Each Resource Type directory contains its schema and implementations for supported deployment targets, making the repository a useful source of complete examples. + +Before defining a Resource Type from scratch, look for one with similar properties, capabilities, or infrastructure requirements. You can adapt an existing definition for your organization or follow the [contribution guide](https://github.com/radius-project/resource-types-contrib/blob/main/docs/contributing/contributing-resource-types-recipes.md) to propose a Resource Type and recipes for the community library. + +## Step 1: Choose the namespace, type name, and API version + +A Resource Type definition starts with a namespace, one or more type names, and at least one API version: + +```yaml +namespace: MyCompany.Resources +types: + widgets: + description: Resources that represent widgets managed by MyCompany. + apiVersions: + '2025-08-01-preview': + schema: + type: object +``` + +Use a namespace that identifies your organization. Namespaces use the `PrimaryName.SecondaryName` format; the `Radius.` prefix is reserved for built-in and community-maintained types. Type names are typically plural and camelCase. + +Use a date-based API version such as `2025-08-01-preview`. Add a new API version when making a breaking schema change so existing applications can continue using the earlier contract. + +## Step 2: Define the resource properties + +Under each API version, define an OpenAPI schema for the resource. Use `required` for properties developers must supply and `readOnly` for values populated after provisioning: + +```yaml +schema: + type: object + properties: + environment: + type: string + description: The Radius Environment resource ID. + application: + type: string + description: The Radius Application resource ID. + size: + type: string + enum: [small, medium, large] + description: The requested resource size. + endpoint: + type: string + readOnly: true + description: The endpoint returned after the resource is provisioned. + required: [environment, size] +``` + +Radius supports string, integer, number, boolean, array, and object properties. Object properties can contain named `properties` or define a typed map with `additionalProperties`. See [Defining a Resource Type]({{< ref "/reference/resources/#defining-a-resource-type" >}}) for the complete schema conventions. + +## Step 3: Choose the provisioning behavior + +Most Resource Types use a [recipe]({{< ref "/extensibility/recipes" >}}) to provision backing infrastructure. For a recipe-backed Resource Type, omit `capabilities`; the Recipe Pack assigned to the Environment determines which recipe Radius runs. + +Use `ManualResourceProvisioning` only when Radius should store the supplied properties without running a recipe: + +```yaml +types: + widgets: + capabilities: + - ManualResourceProvisioning +``` + +Manual provisioning is suitable for resources that model infrastructure managed outside Radius. It does not create, update, or delete backing infrastructure. + +## Step 4: Handle sensitive properties + +For a recipe-backed Resource Type, mark sensitive string or object properties with `x-radius-sensitive`: + +```yaml +properties: + apiKey: + type: string + x-radius-sensitive: true + description: An API key passed securely to the recipe. +``` + +Radius encrypts these values at rest, redacts them from reads, and decrypts them only when needed by the recipe. For a manually provisioned type, store secrets in a separate [`Radius.Security/secrets`]({{< ref "/reference/resources/radius.security" >}}) resource and expose only its resource ID on the custom type. + +## Step 5: Create and inspect the Resource Type + +Save the complete definition as a YAML or JSON file. Create or update all Resource Types in the file with [`rad resource-type create`]({{< ref rad_resource-type_create >}}): + +```bash +rad resource-type create --from-file resource-types.yaml +``` + +To create or update only one type from a file containing several types, provide its simple name: + +```bash +rad resource-type create widgets --from-file resource-types.yaml +``` + +Inspect the registered type with [`rad resource-type show`]({{< ref rad_resource-type_show >}}), or use `rad resource-type list` to list all registered types: + +```bash +rad resource-type show MyCompany.Resources/widgets +rad resource-type list +``` + +## Step 6: Publish a Bicep extension + +Registering the Resource Type makes it available to the Radius control plane. To give developers type checking and authoring support in Bicep, compile the definition into a Bicep extension with [`rad bicep publish-extension`]({{< ref rad_bicep_publish-extension >}}). + +See [Distribute Bicep extensions to developers]({{< ref "/installation/dev-workstation#distribute-bicep-extensions-to-developers" >}}) to publish the extension to Azure Container Registry or a local file and configure it in each developer's `bicepconfig.json`. + +## Next steps + +After creating a custom Resource Type, create a recipe which deploys the new Resource Type to a cloud provider. + +{{< button text="Next step: How to create a custom recipe" page="/extensibility/recipes" >}} diff --git a/docs/content/guides/_index.md b/docs/content/guides/_index.md deleted file mode 100644 index 8c2597bb9..000000000 --- a/docs/content/guides/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Radius how-to guides" -linkTitle: "How-to guides" -description: "Learn how to use Radius with detailed guides" -weight: 40 ---- \ No newline at end of file diff --git a/docs/content/guides/author-apps/_index.md b/docs/content/guides/author-apps/_index.md deleted file mode 100644 index e5bc51a70..000000000 --- a/docs/content/guides/author-apps/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Authoring applications" -linkTitle: "Authoring applications" -description: "Learn how to author a Radius Application" -weight: 100 ---- \ No newline at end of file diff --git a/docs/content/guides/author-apps/aws/_index.md b/docs/content/guides/author-apps/aws/_index.md deleted file mode 100644 index 4f0e8a85e..000000000 --- a/docs/content/guides/author-apps/aws/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "AWS resources" -linkTitle: "AWS" -description: "Deploy and connect to AWS resources in your application" -weight: 700 ---- \ No newline at end of file diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/icon.png b/docs/content/guides/author-apps/aws/howto-aws-resources/icon.png deleted file mode 100644 index 7c568e239..000000000 Binary files a/docs/content/guides/author-apps/aws/howto-aws-resources/icon.png and /dev/null differ 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 deleted file mode 100644 index 95f5ab2e2..000000000 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -type: docs -title: "How-To: Deploy AWS resources" -linkTitle: "Deploy AWS resources" -description: "Learn about how to add AWS resources to your application and deploy them with Radius" -categories: "How-To" -tags: ["AWS"] -weight: 200 ---- - -This how-to guide will show you: - -- How to model an AWS S3 resource in Bicep -- How to use a sample application to interact with AWS S3 bucket - -{{< image src="s3appdiagram.png" alt="Screenshot of the sample application to interact with s3 bucket " width=400 >}} - -## Prerequisites - -- Make sure you have an [AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account) and an [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) - - [Create an IAM AWS access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) and copy the AWS Access Key ID and the AWS Secret Access Key to a secure location for use later. If you have already created an Access Key pair, you can use that instead. -- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) - - Configure your CLI with [`aws configure`](https://docs.aws.amazon.com/cli/latest/reference/configure/index.html), specifying your configuration values -- [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" >}}) -- [Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - -## Step 1: Create an EKS Cluster - -Create an EKS cluster by using the `eksctl` CLI. - -```bash -eksctl create cluster --name <my-cluster> --region=<my-region> -``` - -## Step 2: Create a Radius Environment with the AWS cloud provider - -Create a [Radius Environment]({{< ref "concepts/environments" >}}) where you will deploy your application. - -Run [`rad init --full`]({{< ref rad_initialize >}}) to initialize a new environment into your current kubectl context: - -```bash -rad init --full -``` - -Follow the prompts to install Radius , create an [environment resource]({{< ref "/guides/deploy-apps/environments" >}}), and create a [local workspace]({{< ref workspaces >}}). You will be asked for: - -- **Namespace** - When an application is deployed, this is the namespace where your containers and other Kubernetes resources will be run. By default, this will be in the `default` namespace. -{{% alert title="πŸ’‘ About namespaces" color="success" %}} When you initialize a Radius Kubernetes environment, Radius installs the control plane resources within the `radius-system` namespace in your cluster, separate from your applications. The namespace specified in this step will be used for your application deployments. -{{% /alert %}} -- **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-access-key" >}}) with the preferred identity. -- **Environment name** - The name of the environment to create. You can specify any name with lowercase letters, such as `myawsenv`. - -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: - -{{< rad file="snippets/s3.bicep" embed=true >}} - -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 5: Add a Radius container to interact with the AWS S3 Bucket - -Open the `app.bicep` and append the following Radius resources: - -{{< rad file="snippets/s3app.bicep" embed=true marker="//S3APP" >}} - -Your final `app.bicep` file should look like this - -{{< rad file="snippets/app.bicep" embed=true >}} - -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 6: Deploy the application - -1. Deploy your application to your environment: - - ```bash - rad deploy ./app.bicep -p aws_access_key_id=<AWS_ACCESS_KEY_ID> -p aws_secret_access_key=<AWS_SECRET_ACCESS_KEY> - ``` - - > Replace `<AWS_ACCESS_KEY_ID>` and `<AWS_SECRET_ACCESS_KEY>` with the values obtained from the previous step. - - {{% alert title="Warning" color="warning" %}}It is always recommended to have separate IAM credentials for your container to communicate with S3 or any other data store. - Radius is currently working on supporting direct connections to AWS resources so that your container can automatically communicate with the data store securely without having to manage separate credentials for data plane operations{{% /alert %}} - -1. Port-forward the container to your machine with [`rad resource expose`]({{< ref rad_resource_expose >}}): - - ```bash - rad resource expose Applications.Core/containers frontend -a s3app --port 5234 - ``` - -1. Visit [localhost:5234](http://localhost:5234/swagger/index.html) in your browser. This is a swagger doc for the sample application. You can use this to interact with the AWS S3 Bucket you created. For example, you can try to upload a file to the bucket via the `/upload` endpoint. - - {{< image src="s3app.png" alt="Screenshot of the sample application to interact with s3 bucket " width=900 >}} - -## Step 7: Cleanup - -1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_environment_delete.md >}}) to delete all Radius resources running on the EKS Cluster. - -1. Cleanup AWS Resources - AWS resources are not deleted when deleting a Radius Environment, so make sure to delete all resources created in this reference app to prevent additional charges. You can delete these resources in the AWS Console or via the AWS CLI. Instructions to delete an AWS S3 Bucket are available [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html). - -## Troubleshooting - -If you hit errors while deploying the application, please follow the steps below to troubleshoot: - -1. Check if the AWS credentials are valid. Login to the AWS console and check if the IAM access key and secret access key are valid and not expired. - -1. Look at the control plane logs to see if there are any errors. You can use the following command to view the logs: - - ```bash - rad debug-logs - ``` - - Inspect the UCP logs to see if there are any errors - -If you have issues with the sample application, where the container doesn't connect with the S3 bucket, please follow the steps below to troubleshoot: - -1. Use the below command to inspect logs from container: - - ```bash - rad resource logs Applications.Core/containers frontend -a s3app - ``` - -Also make sure to [open an Issue](https://github.com/radius-project/radius/issues/new/choose) if you encounter a generic `Internal server error` message or an error message that is not self-serviceable, so we can address the root error not being forwarded to the user. - -## Further Reading - -- [Supported AWS resource types]({{< ref "/reference/resource-schema/aws" >}}) diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/s3app.png b/docs/content/guides/author-apps/aws/howto-aws-resources/s3app.png deleted file mode 100644 index 5e7fe94a7..000000000 Binary files a/docs/content/guides/author-apps/aws/howto-aws-resources/s3app.png and /dev/null differ diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/s3appdiagram.png b/docs/content/guides/author-apps/aws/howto-aws-resources/s3appdiagram.png deleted file mode 100644 index fbab763a7..000000000 Binary files a/docs/content/guides/author-apps/aws/howto-aws-resources/s3appdiagram.png and /dev/null differ 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 deleted file mode 100644 index b152b2a8b..000000000 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/app.bicep +++ /dev/null @@ -1,59 +0,0 @@ -extension aws - -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' - -resource s3 'AWS.S3/Bucket@default' = { - alias: bucket - properties: { - BucketName: bucket - } -} - -@description('The environment ID of your Radius Application. Set automatically by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 's3app' - properties: { - environment: environment - } -} - -@description('IAM Access Key ID') -@secure() -param aws_access_key_id string - -@description('IAM Access Key Secret') -@secure() -param aws_secret_access_key string - -@description('Region where the S3 bucket is created. This will be the same region that you input when adding AWS cloudprovider to an environment in Radius.') -param aws_region string = 'us-west-2' - -// get a radius container which uses the s3 bucket -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: app.id - container: { - env: { - BUCKET_NAME: { - value: s3.properties.BucketName - } - AWS_ACCESS_KEY_ID: { - value: aws_access_key_id - } - AWS_SECRET_ACCESS_KEY: { - value: aws_secret_access_key - } - AWS_DEFAULT_REGION: { - value: aws_region - } - } - image: 'ghcr.io/radius-project/samples/aws:latest' - } - } -} 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 deleted file mode 100644 index 65567867a..000000000 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3.bicep +++ /dev/null @@ -1,11 +0,0 @@ -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)}' - -resource s3 'AWS.S3/Bucket@default' = { - alias: bucket - properties: { - BucketName: bucket - } -} 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 deleted file mode 100644 index 1c308e3d5..000000000 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3app.bicep +++ /dev/null @@ -1,61 +0,0 @@ -extension aws - -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' - -resource s3 'AWS.S3/Bucket@default' = { - alias: bucket - properties: { - BucketName: bucket - } -} - -//S3APP -@description('The environment ID of your Radius Application. Set automatically by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 's3app' - properties: { - environment: environment - } -} - -@description('IAM Access Key ID') -@secure() -param aws_access_key_id string - -@description('IAM Access Key Secret') -@secure() -param aws_secret_access_key string - -@description('Region where the S3 bucket is created. This will be the same region that you input when adding AWS cloud provider to an environment in Radius.') -param aws_region string = 'us-west-2' - -// get a radius container which uses the s3 bucket -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: app.id - container: { - env: { - BUCKET_NAME: { - value: s3.properties.BucketName - } - AWS_ACCESS_KEY_ID: { - value: aws_access_key_id - } - AWS_SECRET_ACCESS_KEY: { - value: aws_secret_access_key - } - AWS_DEFAULT_REGION: { - value: aws_region - } - } - image: 'ghcr.io/radius-project/samples/aws:latest' - } - } -} -//S3APP diff --git a/docs/content/guides/author-apps/aws/overview/index.md b/docs/content/guides/author-apps/aws/overview/index.md deleted file mode 100644 index f4712d83e..000000000 --- a/docs/content/guides/author-apps/aws/overview/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -type: docs -title: "Overview: AWS resources" -linkTitle: "Overview" -description: "Deploy and connect to AWS resources in your application" -weight: 100 -categories: "Overview" -tags: ["AWS"] ---- - -Radius Applications are able to connect to and leverage AWS resource with Bicep. Simply model your AWS resources in Bicep and connect to them from Radius resources. - -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. - -## Configure an AWS Provider - -The AWS provider allows you to deploy and connect to AWS resources from a Radius Environment on an EKS cluster. To configure an AWS provider, you can follow the documentation [here]({{< ref "/guides/operations/providers/aws-provider" >}}). - -## Example - -{{< tabs Bicep >}} - -{{% codetab %}} -In the following example, a [Container]({{< ref "guides/author-apps/containers" >}}) is connecting to an S3 bucket. - -{{< rad file="snippets/aws.bicep" embed=true >}} -{{% /codetab %}} - -{{< /tabs >}} - -## Resource library - -{{< button text="AWS resource library" link="/reference/resource-schema/aws" newtab="true" >}} diff --git a/docs/content/guides/author-apps/aws/overview/snippets/aws.bicep b/docs/content/guides/author-apps/aws/overview/snippets/aws.bicep deleted file mode 100644 index 943cc5171..000000000 --- a/docs/content/guides/author-apps/aws/overview/snippets/aws.bicep +++ /dev/null @@ -1,55 +0,0 @@ -extension aws - -extension radius - -param environment string - -param bucket string = 'mybucket' - -@secure() -param aws_access_key_id string - -@secure() -param aws_secret_access_key string - -param aws_region string - -resource s3 'AWS.S3/Bucket@default' = { - alias: 's3' - properties: { - BucketName: bucket - AccessControl: 'PublicRead' - } -} - -// get a radius container which uses the s3 bucket -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 's3app' - properties: { - environment: environment - } -} - -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 's3container' - properties: { - application: app.id - container: { - env: { - BUCKET_NAME: { - value: s3.properties.BucketName - } - AWS_ACCESS_KEY_ID: { - value: aws_access_key_id - } - AWS_SECRET_ACCESS_KEY: { - value: aws_secret_access_key - } - AWS_DEFAULT_REGION: { - value: aws_region - } - } - image: 'ghcr.io/radius-project/samples/aws:latest' - } - } -} diff --git a/docs/content/guides/author-apps/azure/_index.md b/docs/content/guides/author-apps/azure/_index.md deleted file mode 100644 index b7d1a17be..000000000 --- a/docs/content/guides/author-apps/azure/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Microsoft Azure resources" -linkTitle: "Azure" -description: "Deploy and connect to Azure resources in your application" -weight: 800 ---- diff --git a/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-app.png b/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-app.png deleted file mode 100644 index bfff68e30..000000000 Binary files a/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-app.png and /dev/null differ diff --git a/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-env.png b/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-env.png deleted file mode 100644 index b0f8148cf..000000000 Binary files a/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-env.png and /dev/null differ diff --git a/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-gateway.png b/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-gateway.png deleted file mode 100644 index e1f1e4fff..000000000 Binary files a/docs/content/guides/author-apps/azure/howto-azure-container-instances/azure-portal-gateway.png and /dev/null differ diff --git a/docs/content/guides/author-apps/azure/howto-azure-container-instances/demo-app-landing.png b/docs/content/guides/author-apps/azure/howto-azure-container-instances/demo-app-landing.png deleted file mode 100644 index 67e470604..000000000 Binary files a/docs/content/guides/author-apps/azure/howto-azure-container-instances/demo-app-landing.png and /dev/null differ diff --git a/docs/content/guides/author-apps/azure/howto-azure-container-instances/demo-app.png b/docs/content/guides/author-apps/azure/howto-azure-container-instances/demo-app.png deleted file mode 100644 index 6bab2cb7d..000000000 Binary files a/docs/content/guides/author-apps/azure/howto-azure-container-instances/demo-app.png and /dev/null differ diff --git a/docs/content/guides/author-apps/azure/howto-azure-container-instances/index.md b/docs/content/guides/author-apps/azure/howto-azure-container-instances/index.md deleted file mode 100644 index 21b6ae36d..000000000 --- a/docs/content/guides/author-apps/azure/howto-azure-container-instances/index.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -type: docs -title: "How-To: Deploy an Application to Azure Container Instances" -linkTitle: "Deploy to ACI" -description: "Learn how to configure and deploy an application to Azure Container Instances" -weight: 500 -slug: 'azure-container-instances' -categories: "How-To" -tags: ["Azure","containers"] ---- - -This how-to guide will provide an overview of how to: - -- Configure and deploy a Radius [Environment]({{< ref "concepts/environments" >}}) that uses [Azure Container Instances (ACI)](https://learn.microsoft.com/en-us/azure/container-instances/) as the compute provider. -- Define and deploy the demo application to the ACI Radius Environment, which provisions the necessary resources to run the application in ACI. - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -The [Bicep extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) for VS Code is recommended for Bicep language support -- Radius [installed]({{< ref "/guides/operations/kubernetes/kubernetes-install" >}}) on a [supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-kubernetes-clusters" >}}) -- An Azure provider configured and registered with your Radius control plane, either through [Service Principal](https://docs.radapp.io/guides/operations/providers/azure-provider/howto-azure-provider-sp/) or [Workload Identity](https://docs.radapp.io/guides/operations/providers/azure-provider/howto-azure-provider-wi/) that have been assigned to the `Reader` role on the subscription and the `Contributor` role on the resource group where the ACI containers will be deployed -- A [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/) is [required]({{< ref "/reference/resource-schema/core-schema/environment-schema#identity" >}}) for ACI deployments, if you choose to utilize a [user-assigned managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/how-manage-user-assigned-managed-identities?pivots=identity-mi-methods-azp) then you need to ensure it is assigned to the `Contributor` and `Azure Container Instances Contributor` roles on the subscription and resource group where the ACI containers will be deployed - -## Step 1: Create a Radius Resource Group and Workspace - -Since the Radius control plane is hosted on your Kubernetes cluster, you'll need to create a new Radius Resource Group and Workspace so that you can target your application deployments to an ACI Environment. These will then be associated with the ACI Environment that you will configure and create in subsequent steps. - -1. Create a new Radius Workspace called `aci-workspace`: - ```bash - rad workspace create kubernetes aci-workspace - ``` - -1. Then, create a new Radius Resource Group called `aciGroup` and switch to it: - ```bash - rad group create aciGroup - rad group switch aciGroup - ``` - -1. Finally, create a new ACI Environment within the `aci-workspace` workspace you just created and switch to it: - ```bash - rad env create aci-demo -w aci-workspace - rad env switch aci-demo - ``` - -## Step 2: Define the Environment with ACI compute - -Create a new file named `env.bicep` and add the following Environment definition. This Environment uses the `aci` compute provider and a user-assigned managed identity to provision the necessary resources for ACI and also registers a default Recipe for provisioning an Azure Redis Cache. - -{{< rad file="snippets/env.bicep" embed=true >}} - -> Note: be sure to replace the `resourceGroup` and `scope` values with your resource group ID and the `managedIdentity` value with your managed identity resource ID. - -## Step 3: Deploy the Environment - -1. Run the following command to deploy the Environment and associate it with the `aci-workspace` you created in the previous step: - ```bash - rad deploy ./env.bicep --workspace aci-workspace - ``` - - You should see the following terminal output: - - ``` - Deployment In Progress... - - Deployment Complete - - Resources: - aci-demo Applications.Core/environments - ``` - -<br> - -Navigate to your resource group in the [Azure portal](https://portal.azure.com/) and you should see the relevant Azure resources that were provisioned by Radius for your ACI Radius Environment, including the virtual network, internal load balancer, and network security group: - -{{< image src="azure-portal-env.png" alt="Screenshot of the Azure portal showing the resource group with the virtual network, internal load balancer, and network security group resources created by Radius" width=700px >}} - -## Step 4: Define the Application and its resources - -Create a file named `app.bicep` and add the application definition, along with Redis cache, gateway, and container resources to the file: - -{{< rad file="snippets/app.bicep" embed=true >}} - -> Notice that for ACI containers, you define a Gateway resource that provides L7 traffic for the container. Radius will provision an Azure Application Gateway on your behalf and configure the container to use the Gateway as its ingress. The Gateway will be provisioned with a public IP address and a DNS name that you can use to access the application. - -## Step 5: Deploy the Application - -Run the following command to deploy the application: - -```bash -rad deploy ./app.bicep --workspace aci-workspace -``` - -> Note that you are deploying the application specifically targeting the `aci-workspace` you had created in a previous step, which ensures that your application gets deployed to the ACI Environment. The same application can also be targeted to deploy into a workspace associated with a Kubernetes Radius Environment instead. - -Once the deployment succeeds, you should see the following terminal output: - -``` -Deployment In Progress... - -Completed database Applications.Datastores/redisCaches -Completed gateway Applications.Core/gateways -Completed demo-app Applications.Core/applications -.. frontend Applications.Core/containers - -Deployment Complete - -Resources: - demo-app Applications.Core/applications - frontend Applications.Core/containers - gateway Applications.Core/gateways - database Applications.Datastores/redisCaches - -Public Endpoints: - gateway Applications.Core/gateways http://gateway.demo-app.4.149.194.115.nip.io -``` - -## Step 6: View the deployed resources - -Now you can check the Radius application graph in your terminal to view resources that were provisioned for your application: - -```bash -rad app graph -a demo-app -``` - -You should see the following output: - -``` -Displaying application: demo-app - -Name: frontend (Applications.Core/containers) -Connections: - gateway (Applications.Core/gateways) -> frontend - frontend -> database (Applications.Datastores/redisCaches) -Resources: - frontend (Microsoft.ContainerInstance/containerGroupProfiles) - frontend (Microsoft.ContainerInstance/nGroups) - frontend (Microsoft.Network/loadBalancers/applications) - frontend (Microsoft.Network/virtualNetworks/subnets) - -Name: gateway (Applications.Core/gateways) -Connections: - gateway -> frontend (Applications.Core/containers) -Resources: - gateway (Microsoft.Network/applicationGateways) - gateway-nsg (Microsoft.Network/networkSecurityGroups) - gateway (Microsoft.Network/publicIPAddresses) - gateway (Microsoft.Network/virtualNetworks/subnets) - -Name: database (Applications.Datastores/redisCaches) -Connections: - frontend (Applications.Core/containers) -> database -Resources: - cache-vxkt2iou25nht (Microsoft.Cache/redis) -``` - -Navigate to your resource group in the [Azure portal](https://portal.azure.com/) and you should see the relevant Azure resources that were provisioned by Radius for your application, including the container instance, container group profile, Ngroup, load balancer, virtual network, and network security groups that are required for the application to run on ACI: - -{{< image src="azure-portal-app.png" alt="Screenshot of the Azure portal showing the resource group with all the ACI resources" width=700px >}} -<br> - -## Step 7: Browse the Application - -In your Azure portal, click on the Gateway public IP address resource and you should see the public IP address of the Gateway resource. This is the public DNS name that you can use to access your application. Copy the public DNS name. - -{{< image src="azure-portal-gateway.png" alt="Screenshot of the Azure portal showing the public IP address of the Gateway resource" width=700px >}}<br> - -Open a web browser and in the address bar paste in the public DNS name of the Gateway resource that you just copied with a `:3000` appended to that address, as the application container is exposed to users on port 3000. You should see the demo application landing page showing that your application is running on your Azure Container Instance, along with some information about its containers and resources. - -{{< image src="demo-app-landing.png" alt="Screenshot of the demo app landing page" width=700px >}} - -Navigate to the Todo List tab and test out the application. Using the Todo page will update the saved state in your Azure Redis cache. - -{{< image src="demo-app.png" alt="Screenshot of the todo list in the demo app" width=700px >}} - -## Cleanup - -1. Run the following command to delete your app and its container and Redis cache resources: - - ```bash - rad app delete demo-app --yes - ``` - -1. Run the following command to delete your environment: - - ```bash - rad env delete aci-env --yes - ``` - -1. Run the following command to delete your workspace: - - ```bash - rad workspace delete aci-workspace --yes - ``` - -1. Finally, navigate to your Azure portal and delete the related resources that were created for the ACI Environment, namely the virtual network, internal load balancer, and network security group. You can also delete the resource group if you no longer need it. - - {{< image src="azure-portal-env.png" alt="Screenshot of the Azure portal showing the resource group with the virtual network, internal load balancer, and network security group resources created by Radius" width=700px >}} - -## Further reading -- [Azure resources overview]({{< ref "/guides/author-apps/azure/overview" >}}) -- [Radius Environment schema]({{< ref "/reference/resource-schema/core-schema/environment-schema" >}}) -- [Radius Application schema]({{< ref "/reference/resource-schema/core-schema/application-schema" >}}) -- [Radius Container schema]({{< ref "/reference/resource-schema/core-schema/container-schema" >}}) \ No newline at end of file diff --git a/docs/content/guides/author-apps/azure/howto-azure-container-instances/snippets/app.bicep b/docs/content/guides/author-apps/azure/howto-azure-container-instances/snippets/app.bicep deleted file mode 100644 index ca9cb4c55..000000000 --- a/docs/content/guides/author-apps/azure/howto-azure-container-instances/snippets/app.bicep +++ /dev/null @@ -1,62 +0,0 @@ -extension radius - -param environment string = 'aci-demo' - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'demo-app' - properties: { - environment: environment - } -} - -resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview' = { - name: 'database' - properties: { - environment: environment - application: app.id - } -} - -resource gateway 'Applications.Core/gateways@2023-10-01-preview' = { - name: 'gateway' - properties: { - application: app.id - routes: [ - { - path: '/' - destination: 'http://frontend:3000' - } - ] - } -} - -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - connections: { - redis: { - source: redis.id - } - } - extensions: [ - { - kind: 'manualScaling' - replicas: 2 - } - ] - runtimes: { - aci: { - gatewayID: gateway.id - } - } - } -} diff --git a/docs/content/guides/author-apps/azure/howto-azure-container-instances/snippets/env.bicep b/docs/content/guides/author-apps/azure/howto-azure-container-instances/snippets/env.bicep deleted file mode 100644 index 4b52c7402..000000000 --- a/docs/content/guides/author-apps/azure/howto-azure-container-instances/snippets/env.bicep +++ /dev/null @@ -1,32 +0,0 @@ -extension radius - -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'aci-demo' - properties: { - compute: { - kind: 'aci' - // Replace value with your resource group ID - resourceGroup: '/subscriptions/<>/resourceGroups/<>' - identity: { - kind:'userAssigned' - // Replace value with your managed identity resource ID - managedIdentity: ['/subscriptions/<>/resourceGroups/<>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<>'] - } - } - recipes: { - 'Applications.Datastores/redisCaches': { - default: { - templateKind: 'bicep' - plainHttp: true - templatePath: 'ghcr.io/radius-project/recipes/azure/rediscaches:latest' - } - } - } - providers: { - azure: { - // Replace value with your resource group ID - scope: '/subscriptions/<>/resourceGroups/<>' - } - } - } -} diff --git a/docs/content/guides/author-apps/azure/howto-azure-resources/icon.png b/docs/content/guides/author-apps/azure/howto-azure-resources/icon.png deleted file mode 100644 index 27c097a44..000000000 Binary files a/docs/content/guides/author-apps/azure/howto-azure-resources/icon.png and /dev/null differ 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 deleted file mode 100644 index 3f7eccb66..000000000 --- a/docs/content/guides/author-apps/azure/howto-azure-resources/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -type: docs -title: "How-To: Connect a container to an Azure resource" -linkTitle: "Deploy Azure resources" -description: "Learn how to connect a container to an Azure resource with managed identities and RBAC" -weight: 600 -slug: 'azure-connection' -categories: "How-To" -tags: ["Azure","containers"] ---- - -This how-to guide will provide an overview of how to: - -- Setup a Radius Environment with an identity provider -- Define a connection to an Azure resource with Azure AD role-based access control (RBAC) assignments -- Leverage Azure managed identities to connect to an Azure resource - -The steps below will showcase a "rad-ified" version of the existing [Azure AD workload identity quickstart](https://azure.github.io/azure-workload-identity/docs/quick-start.html). - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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) - -## Step 1: Initialize Radius - -Begin by running [`rad init --full`]({{< ref rad_initialize >}}). Make sure to configure an Azure cloud provider: - -```bash -rad init --full -``` - -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]({{< ref "concepts/environments" >}}) with identity property 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 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 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). - -```bash -rad deploy ./app.bicep -p oidcIssuer=<OIDC_ISSUER_URL> -``` - -## Step 6: Verify access to the Key Vault - -1. Once deployment completes, read the logs from your running container resource: - - ```bash - rad resource logs Applications.Core/containers mycontainer -a myapp - ``` - -1. You should see the contents of the secret from your Key Vault: - - ```txt - [myapp-mycontainer-79c54bd7c7-tgdpn] I1108 18:39:53.636314 1 main.go:33] "successfully got secret" secret="supersecret" - ``` - - Note: the container retrieves the secret every 60 seconds. If you get an error on the first attempt, wait a minute and try again. The Azure AD federation may still be in progress. - -## Cleanup - -1. Run the following command to delete your app and container: - - ```bash - rad app delete myapp --yes - ``` - -1. Delete the deployed Azure Key Vault via the Azure portal or the Azure CLI 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 deleted file mode 100644 index ba161e594..000000000 --- a/docs/content/guides/author-apps/azure/howto-azure-resources/snippets/container-wi.bicep +++ /dev/null @@ -1,90 +0,0 @@ -//ENVIRONMENT -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 - -@description('Specifies the OIDC issuer URL') -param oidcIssuer string - -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'iam-quickstart' - properties: { - compute: { - kind: 'kubernetes' - resourceId: 'self' - namespace: 'iam-quickstart' - identity: { - kind: 'azure.com.workload' - oidcIssuer: oidcIssuer - } - } - providers: { - azure: { - scope: resourceGroup().id - } - } - } -} -//ENVIRONMENT - -//CONTAINER -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: env.id - } -} - -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'mycontainer' - properties: { - application: app.id - container: { - image: 'ghcr.io/azure/azure-workload-identity/msal-go:latest' - env: { - KEYVAULT_NAME: { - value: keyvault.name - } - KEYVAULT_URL: { - value: keyvault.properties.vaultUri - } - SECRET_NAME: { - value: 'mysecret' - } - } - } - connections: { - vault: { - source: keyvault.id - iam: { - kind: 'azure' - roles: [ - 'Key Vault Secrets User' - ] - } - } - } - } -} - -resource keyvault 'Microsoft.KeyVault/vaults@2021-10-01' = { - name: 'qs-${uniqueString(resourceGroup().id)}' - location: azLocation - properties: { - enabledForTemplateDeployment: true - tenantId: subscription().tenantId - enableRbacAuthorization: true - sku: { - name: 'standard' - family: 'A' - } - } - resource mySecret 'secrets' = { - name: 'mysecret' - properties: { - value: 'supersecret' - } - } -} -//CONTAINER diff --git a/docs/content/guides/author-apps/azure/overview/index.md b/docs/content/guides/author-apps/azure/overview/index.md deleted file mode 100644 index 9ecbff7e5..000000000 --- a/docs/content/guides/author-apps/azure/overview/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -type: docs -title: "Overview: Microsoft Azure resources" -linkTitle: "Overview" -description: "Deploy and connect to Azure resources in your application" -weight: 100 -categories: "Overview" -tags: ["Azure"] ---- - -Radius Applications are able to connect to and leverage every Azure resource with Bicep. Simply model your Azure resources in Bicep and add a connection from your Radius resources. Radius can deploy your application containers to both Azure Kubernetes Service (AKS) or Azure Container Instances (ACI). - -## Configure an Azure Provider - -The Azure provider allows you to deploy and connect to Azure resources from a Radius Environment on any of the [supported k8s clusters]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) or [Azure Container Instances (ACI)]({{< ref "/guides/author-apps/azure/howto-azure-container-instances" >}}). To configure an Azure provider, you can follow the documentation [here]({{< ref "/guides/operations/providers/azure-provider" >}}). - -## Set up an Azure compute environment - -Radius allows you to target the deployment of your application containers to either Azure Kubernetes Service (AKS) or Azure Container Instances (ACI). The underlying compute platform is preconfigured in the Radius Environment, which means that you are able to deploy a Radius application to either AKS or ACI without needing to change the application definition. To learn more, visit the following resources: -- The [Kubernetes operations guide](https://docs.radapp.io/guides/operations/kubernetes/overview/#supported-kubernetes-clusters) has more information about setting up Radius in an AKS cluster -- The [how-to guide for ACI]({{< ref "/guides/author-apps/azure/howto-azure-container-instances" >}}) details how to configure a Radius Environment with ACI as the underlying compute platform and deploy a Radius application to ACI - -## Resource library - -Visit [the Microsoft docs](https://docs.microsoft.com/azure/templates/) to reference every Azure resource and how to represent it in Bicep. - -{{< button text="Azure resource library" link="https://docs.microsoft.com/azure/templates/" newtab="true" >}} - -## Example - -{{< tabs Bicep >}} - -{{% codetab %}} -In the following example, a [Container]({{< ref "guides/author-apps/containers" >}}) is connecting to an Azure Cache for Redis resource. The Container is assigned the `Redis Cache Contributor` role: - -{{< rad file="snippets/azure-connection.bicep" embed=true >}} -{{% /codetab %}} - -{{< /tabs >}} - 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 deleted file mode 100644 index a30e02434..000000000 --- a/docs/content/guides/author-apps/azure/overview/snippets/azure-connection.bicep +++ /dev/null @@ -1,51 +0,0 @@ -extension radius - -param environment string - -@description('The Azure region to deploy Azure resource(s) into. Defaults to the region of the target Azure resource group.') -param location string = resourceGroup().location - -resource cache 'Microsoft.Cache/Redis@2019-07-01' = { - name: 'mycache' - location: location - properties: { - sku: { - capacity: 0 - family: 'C' - name: 'Basic' - } - } -} - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'mycontainer' - properties: { - application: app.id - container: { - image: 'myimage' - env: { - REDIS_HOST: { - value: cache.properties.hostName - } - } - } - connections: { - redis: { - iam: { - kind: 'azure' - roles: [ - 'Redis Cache Contributor' - ] - } - source: cache.id - } - } - } -} diff --git a/docs/content/guides/author-apps/containers/_index.md b/docs/content/guides/author-apps/containers/_index.md deleted file mode 100644 index 89add960a..000000000 --- a/docs/content/guides/author-apps/containers/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Radius containers" -linkTitle: "Containers" -description: "Learn how to model and run container workloads in your Radius Application" -weight: 200 ---- diff --git a/docs/content/guides/author-apps/containers/howto-connect-dependencies/demo-with-redis-screenshot.png b/docs/content/guides/author-apps/containers/howto-connect-dependencies/demo-with-redis-screenshot.png deleted file mode 100644 index 9aa700ed3..000000000 Binary files a/docs/content/guides/author-apps/containers/howto-connect-dependencies/demo-with-redis-screenshot.png and /dev/null differ 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 deleted file mode 100644 index b39de88ac..000000000 --- a/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -type: docs -title: "How-To: Connect to dependencies" -linkTitle: "Connect to dependencies" -description: "Learn how to connect to dependencies in your application via connections" -weight: 200 -categories: "How-To" -tags: ["containers"] ---- - -This how-to guide will teach how to connect to your dependencies via [connections]({{< ref "guides/author-apps/containers#connections" >}}) - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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 - -Open the `app.bicep` and view the [container]({{< ref "guides/author-apps/containers" >}}): - -{{< rad file="snippets/app.bicep" embed=true >}} - -## Step 2: Add a Redis cache as a dependency - -Next, add to `app.bicep` a [Redis cache]({{< ref "/guides/author-apps/portable-resources/overview" >}}), leveraging the default "local-dev" Recipe: - -{{< rad file="snippets/app-with-redis.bicep" embed=true marker="//DB" >}} - -## Step 3: Connect to the Redis cache - -Connections from a container to a resource result in environment variables for connection information automatically being set on the container. Update your container definition to add a connection to the new Redis cache: - -{{< rad file="snippets/app-with-redis.bicep" embed=true marker="//CONTAINER" markdownConfig="{linenos=table,hl_lines=[\"13-17\"],linenostart=7}" >}} - -## Step 4: Deploy your app - -1. Run your application in your environment: - - ```bash - rad run ./app.bicep -a demo - ``` - -1. Visit [localhost:3000](http://localhost:3000) in your browser. You should see the following page, now showing injected environment variables: - - {{< image src="./demo-with-redis-screenshot.png" alt="Screenshot of the demo app with all environment variables" width=1000px >}} - -## Step 5: View the Application Connections - -Radius Connections are more than just environment variables and configuration. You can also access the "application graph" and understand the connections within your application with the following command: - -```bash -rad app graph -a demo -``` - -You should see the following output, detailing the connections between the `demo` container and the `db` Redis cache, along with information about the underlying Kubernetes resources running the app: - -``` -Displaying application: demo - -Name: demo (Applications.Core/containers) -Connections: - demo -> db (Applications.Datastores/redisCaches) -Resources: - demo (kubernetes: apps/Deployment) - demo (kubernetes: core/Secret) - demo (kubernetes: core/Service) - demo (kubernetes: core/ServiceAccount) - demo (kubernetes: rbac.authorization.k8s.io/Role) - demo (kubernetes: rbac.authorization.k8s.io/RoleBinding) - -Name: db (Applications.Datastores/redisCaches) -Connections: - demo (Applications.Core/containers) -> db -Resources: - redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) - redis-r5tcrra3d7uh6 (kubernetes: core/Service) -``` - -## Cleanup - -Run `rad app delete` to cleanup your Radius application, container, and Redis cache: - -```bash -rad app delete -a demo -``` - -## Further reading - -- [Connections]({{< ref "guides/author-apps/containers/overview#connections" >}}) -- [Container schema]({{< ref container-schema >}}) 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 deleted file mode 100644 index 04f9dd16c..000000000 --- a/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app-with-redis.bicep +++ /dev/null @@ -1,40 +0,0 @@ -// Import the set of Radius resources (Applications.*) into Bicep -extension radius - -@description('The app ID of your Radius Application. Set automatically by the rad CLI.') -param application string - -//CONTAINER -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - connections: { - redis: { - source: db.id - } - } - } -} -//CONTAINER - -//DB -@description('The env ID of your Radius Environment. Set automatically by the rad CLI.') -param environment string - -resource db 'Applications.Datastores/redisCaches@2023-10-01-preview' = { - name: 'db' - properties: { - application: application - environment: environment - } -} -//DB 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 deleted file mode 100644 index ee5b94ed0..000000000 --- a/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app.bicep +++ /dev/null @@ -1,19 +0,0 @@ -extension radius - -@description('The app ID of your Radius application. Set automatically by the rad CLI.') -param application string - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - } -} diff --git a/docs/content/guides/author-apps/containers/howto-keyvault-volume/icon.png b/docs/content/guides/author-apps/containers/howto-keyvault-volume/icon.png deleted file mode 100644 index ea641b52a..000000000 Binary files a/docs/content/guides/author-apps/containers/howto-keyvault-volume/icon.png and /dev/null differ 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 deleted file mode 100644 index f722d4c2e..000000000 --- a/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -type: docs -title: "How-To: Mount an Azure Key Vault as a volume to a container" -linkTitle: "Mount a Key Vault" -description: "Learn how to mount an Azure Key Vault as a volume to a container" -weight: 600 -slug: 'volume-keyvault' -categories: "How-To" -tags: ["Azure","containers"] ---- - -This how-to guide will provide an overview of how to: - -- Setup a Radius Environment with an identity provider -- Define a connection to an Azure resource with Azure AD role-based access control (RBAC) assignments -- Leverage Azure managed identities to connect to an Azure resource -- Mount a Key vault as a volume to a container - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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/) - - The above installation will also install the required [Secrets Store CSI Driver](https://secrets-store-csi-driver.sigs.k8s.io/getting-started/installation.html) - -## Step 1: Initialize Radius - -Begin by running [`rad init --full`]({{< ref rad_initialize >}}). Make sure to configure an Azure cloud provider: - -```bash -rad init --full -``` - -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 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 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 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). - -```bash -rad deploy ./app.bicep -p oidcIssuer=<OIDC_ISSUER_URL> -``` - -## Step 7: Verify access to the mounted Azure Key Vault - -1. Once deployment completes, read the logs from your running container resource: - - ```bash - rad resource logs Applications.Core/containers mycontainer -a myapp - ``` - -1. You should see the contents of the `/var/secrets` mount path defined in your `app.bicep` file: - - ``` - [myapp-mycontainer-d8b4fc44-qrhnn] secret context : supersecret - ``` - - Note: You might need to wait 1-2 minutes for the pods and identities to be set up completely. Retry in a few minutes if you are unable to view the secret contents. - -## Cleanup - -1. Run the following command to delete your app and container: - - ```bash - rad app delete myapp --yes - ``` - -1. Delete the deployed Azure Key Vault via the Azure portal or the Azure CLI 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 deleted file mode 100644 index b7b7a921f..000000000 --- a/docs/content/guides/author-apps/containers/howto-keyvault-volume/snippets/keyvault-wi.bicep +++ /dev/null @@ -1,94 +0,0 @@ -//ENVIRONMENT -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 - -@description('Specifies the environment for resources.') -param oidcIssuer string - -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'kv-volume-quickstart' - properties: { - compute: { - kind: 'kubernetes' - namespace: 'kv-volume-quickstart' - resourceId: 'self' - identity: { - kind: 'azure.com.workload' - oidcIssuer: oidcIssuer - } - } - providers: { - azure: { - scope: resourceGroup().id - } - } - } -} -//ENVIRONMENT - -//APP -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: env.id - } -} - -resource volume 'Applications.Core/volumes@2023-10-01-preview' = { - name: 'myvolume' - properties: { - application: app.id - kind: 'azure.com.keyvault' - resource: keyvault.id - secrets: { - mysecret: { - name: 'mysecret' - } - } - } -} - -resource keyvault 'Microsoft.KeyVault/vaults@2021-10-01' = { - name: 'kvqs-${uniqueString(resourceGroup().id)}' - location: azLocation - properties: { - sku: { - family: 'A' - name: 'standard' - } - tenantId: subscription().tenantId - enableRbacAuthorization: true - } - - resource mySecret 'secrets' = { - name: 'mysecret' - properties: { - value: 'supersecret' - } - } -} -//APP - -//CONTAINER -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'mycontainer' - properties: { - application: app.id - container: { - image: 'debian' - command: ['/bin/sh'] - args: ['-c', 'while true; do echo secret context : `cat /var/secrets/mysecret`; sleep 10; done'] - volumes: { - volkv: { - kind: 'persistent' - source: volume.id - mountPath: '/var/secrets' - } - } - - } - } -} -//CONTAINER diff --git a/docs/content/guides/author-apps/containers/howto-volumes/icon.png b/docs/content/guides/author-apps/containers/howto-volumes/icon.png deleted file mode 100644 index 6e6683e34..000000000 Binary files a/docs/content/guides/author-apps/containers/howto-volumes/icon.png and /dev/null differ diff --git a/docs/content/guides/author-apps/containers/howto-volumes/index.md b/docs/content/guides/author-apps/containers/howto-volumes/index.md deleted file mode 100644 index c12bf0a4d..000000000 --- a/docs/content/guides/author-apps/containers/howto-volumes/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -type: docs -title: "How-To: Mount a volume to a container" -linkTitle: "Mount a volume" -description: "Learn how to mount a volume to a container" -weight: 500 -slug: 'volumes' -categories: "How-To" -tags: ["containers"] ---- - -This how-to guide will provide an overview of how to: - -- Mount an ephemeral (short-lived) volume to a container - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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 - -Begin by creating a file named `app.bicep` with a Radius Application and [container]({{< ref "guides/author-apps/containers" >}}): - -{{< rad file="snippets/1-app.bicep" embed=true >}} - -The `samples/volumes` container will display the status and contents of the `/tmpdir` directory within the container. - -## Step 2: Deploy the app and container - -1. Deploy your app with the command: - - ```bash - rad deploy ./app.bicep - ``` - -1. Once complete, port forward to your container with [`rad resource expose`]({{< ref rad_resource_expose >}}): - - ```bash - rad resource expose Applications.Core/containers mycontainer -a myapp --port 5000 - ``` - -1. Visit [localhost:5000](http://localhost:5000) in your browser. You should see a message warning that the directory `/tmpdir` does not exist: - - {{< image src="screenshot-error.jpg" width=500px alt="Screenshot of container showing that the tmp directory does not exist" >}} - -## Step 3: Add an ephemeral volume - -Within the `container.volume` property, add a new volume named `temp` and configure it as a memory-backed ephemeral volume: - -{{< rad file="snippets/2-app.bicep" embed=true marker="//CONTAINER" >}} - -## Redeploy your app and container - -1. Redeploy your application to apply the new definition of your container: - - ```bash - rad deploy ./app.bicep - ``` - -1. Once complete, port forward to your container with [`rad resource expose`]({{< ref rad_resource_expose >}}): - - ```bash - rad resource expose Applications.Core/containers mycontainer -a myapp --port 5000 - ``` - -1. Visit [localhost:5000](http://localhost:5000) in your browser. You should see the contents of `/tmpdir`, showing an empty directory. - - {{< image src="screenshot-empty.jpg" width=500px alt="Screenshot of container showing that the tmp directory has no items" >}} -1. Press the `Create file` button to generate a new file in the directory, such as `test.txt`: - - {{< image src="screenshot.jpg" width=400px alt="Screenshot of container showing files being created" >}} -1. Done! You've now learned how to mount an ephemeral volume - -## Cleanup - -1. Run the following command to delete your app and container: - - ```bash - rad app delete myapp - ``` diff --git a/docs/content/guides/author-apps/containers/howto-volumes/screenshot-empty.jpg b/docs/content/guides/author-apps/containers/howto-volumes/screenshot-empty.jpg deleted file mode 100644 index 1be70d58b..000000000 Binary files a/docs/content/guides/author-apps/containers/howto-volumes/screenshot-empty.jpg and /dev/null differ diff --git a/docs/content/guides/author-apps/containers/howto-volumes/screenshot-error.jpg b/docs/content/guides/author-apps/containers/howto-volumes/screenshot-error.jpg deleted file mode 100644 index 7b3362a90..000000000 Binary files a/docs/content/guides/author-apps/containers/howto-volumes/screenshot-error.jpg and /dev/null differ diff --git a/docs/content/guides/author-apps/containers/howto-volumes/screenshot.jpg b/docs/content/guides/author-apps/containers/howto-volumes/screenshot.jpg deleted file mode 100644 index ec4d7c265..000000000 Binary files a/docs/content/guides/author-apps/containers/howto-volumes/screenshot.jpg and /dev/null differ 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 deleted file mode 100644 index 2a6056ffc..000000000 --- a/docs/content/guides/author-apps/containers/howto-volumes/snippets/1-app.bicep +++ /dev/null @@ -1,20 +0,0 @@ -extension radius - -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'mycontainer' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/volumes:latest' - } - } -} 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 deleted file mode 100644 index b225dcf77..000000000 --- a/docs/content/guides/author-apps/containers/howto-volumes/snippets/2-app.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//CONTAINER -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'mycontainer' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/volumes:latest' - volumes: { - tmp: { - kind: 'ephemeral' - managedStore: 'memory' - mountPath: '/tmpdir' - } - } - } - } -} -//CONTAINER diff --git a/docs/content/guides/author-apps/containers/overview/containers-splash.png b/docs/content/guides/author-apps/containers/overview/containers-splash.png deleted file mode 100644 index 9e2560901..000000000 Binary files a/docs/content/guides/author-apps/containers/overview/containers-splash.png and /dev/null differ diff --git a/docs/content/guides/author-apps/containers/overview/index.md b/docs/content/guides/author-apps/containers/overview/index.md deleted file mode 100644 index a63dd2960..000000000 --- a/docs/content/guides/author-apps/containers/overview/index.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -type: docs -title: "Overview: Radius containers" -linkTitle: "Overview" -description: "Learn how to model and run container workloads in your Radius Application" -weight: 100 -categories: "Overview" -tags: ["containers"] ---- - -A Radius container enables you to run a container workload as part of your application across different platforms and runtimes. Your container can be a frontend UI, a backend API, a database, or any other container you need to run as part of your app. Plus, with Radius Connections, you can easily connect your container to other resources in your application, such as databases, message queues, and more and automatically configure your container with identity, secrets, and other configuration. - -{{< image src="containers-splash.png" alt="Container graphic" width=300px >}} - -> Adding a container and want to jump to the reference docs? Check out the [container resource schema]({{< ref "container-schema" >}}). - -## Supported runtimes - -Radius containers are portable across container runtimes, allowing you to define your container workload once and run it on any of the supported runtimes. - -### Kubernetes - -Containers are deployed to the same Kubernetes cluster as your Radius installation, into the namespace that is defined in your application. For more information on how Radius resources map to Kubernetes objects, refer to the [Kubernetes mapping guide]({{< ref "/guides/operations/kubernetes/overview#resource-mapping" >}}). - -#### Customize Kubernetes configurations - -Radius provides a way to apply custom Kubernetes configurations to container resources that are created by Radius. This allows you to make use of Kubernetes configurations or features that are not supported by Radius, yet remain composable with other Radius features like [Connections]({{< ref "guides/author-apps/containers/overview#connections" >}}). Additionally, it provides a way to migrate your existing Kubernetes applications into Radius without having to rewrite your Kubernetes configurations, while giving you the option to incrementally adopt Radius features over time. The customizations are applied to the container resource via the [`runtimes`]({{< ref "reference/resource-schema/core-schema/container-schema/_index.md#runtimes" >}}) property within the container resource definition. - -##### Base Kubernetes YAML - -You can provide a Kubernetes YAML definition as a base or foundation upon which Radius will build your containers, enabling you to incrementally adopting Radius by starting with your existing YAML definition and use applying Radius customizations on top. The provided YAML is fully passed through to Kubernetes when Radius creates the container resource, which means that you may even provide a definition for a custom resources (CRD) that Radius has no visibility into. <!-- For more information on how to onboard existing Kubernetes resources into Radius, refer to the [base Kubernetes YAML guide]("guides/author-apps/kubernetes/how-to-yaml-base-support"). --> - -Radius currently supports the following Kubernetes resource types for the `base` property: - -| Kubernetes Resource Types | Number of resources | Limitation | -|---------------------------|---------------------|------------| -| Deployment | 1 | Deployment name must match the name of the Radius container | -| ServiceAccount | 1 | ServiceAccount name must match the name of the Radius container using the correct namespace | -| Service | 1 | ServiceAccount name must match the name of the Radius container using the correct namespace | -| Secrets | Multiple | No limitation except within the respective namespace | -| ConfigMap | Multiple config maps | No limitation except within the respective namespace | - -##### Pod patching - -You can also "patch" the Kubernetes containers created and deployed by Radius using [PodSpec](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec) definitions. This allows for setting Kubernetes-specific configurations, as well as overriding Radius behaviors, which means that you may access all Kubernetes Pod features, even if they are not supported by Radius. For more information on how to patch Kubernetes pods, refer to the [Kubernetes pod patching guide]({{< ref "guides/author-apps/kubernetes/how-to-patch-pod" >}}). - -### Azure Container Instances - -Containers can be deployed to Azure Container Instances (ACI) using the `aci` runtime. This allows you to run your container workloads in a serverless environment without needing to manage any infrastructure. For more information on how to deploy containers to ACI, refer to the [Azure Container Instances guide]({{< ref "/guides/author-apps/azure/howto-azure-container-instances" >}}). - -## Container definition - -Radius containers allow you to specify your image, ports, environment variables, volumes, and more. Refer to the [container resource schema]({{< ref "container-schema" >}}) for more information. - -### Ports - -Ports allow you to expose your container to incoming network traffic. Refer to the [networking guide]({{< ref networking >}}) for more information on container networking. - -## Volumes - -Volumes can be mounted to the container to provide access to data. There are two types of volumes, ephemeral and persistent. - -Ephemeral volumes have the same lifecycle as the container, being deployed and deleted with the container. They create an empty directory on the host and mount it to the container. - -Persistent volumes have life cycles that are separate from the container. Containers can mount these persistent volumes and restart without losing data. Persistent volumes can also be useful for storing data that needs to be accessed by multiple containers. - -## Health Probes - -Health probes are used to determine the health of a container. There are two types of probes, readiness and liveness. For more information on how to setup health probes, refer to the [container resource schema]({{< ref "container-schema" >}}). - -### Readiness Probe - -Readiness probes detect when a container begins reporting it is ready to receive traffic, such as after loading a large configuration file that may take a couple seconds to process. There are three types of probes available, httpGet, tcp and exec. - -For an **httpGet** probe, an HTTP GET request at the specified endpoint will be used to probe the application. If a success code is returned, the probe passes. If no code or an error code is returned, the probe fails, and the container won’t receive any requests after a specified number of failures. Any code greater than or equal to 200 and less than 400 indicates success. Any other code indicates failure. - -For a **tcp** probe, the specified container port is probed to be listening. If not, the probe fails. - -For an **exec probe**, a command is run within the container. A return code of 0 indicates a success and the probe succeeds. Any other return indicates a failure, and the container doesn’t receive any requests after a specified number of failures - -Refer to the readiness probes section of the [container resource schema]({{< ref "container-schema#readiness-probes" >}}) for more details. - -### Liveness Probe - -Liveness probes detect when a container is in a broken state, restarting the container to return it to a healthy state. There are three types of probes available, httpGet, tcp and exec. - -For an **httpGet probe**, an HTTP GET request at the specified endpoint will be used to probe the application. If a success code is returned, the probe passes. If no code or an error code is returned, the probe fails, and the container won’t receive any requests after a specified number of failures. Any code greater than or equal to 200 and less than 400 indicates success. Any other code indicates failure. - -For a **tcp probe**, the specified container port is probed to be listening. If not, the probe fails. - -For an **exec probe**, a command is run within the container. A return code of 0 indicates a success and the probe succeeds. Any other return indicates a failure, and the container doesn’t receive any requests after a specified number of failures. - -Refer to the probes section of the [container resource schema]({{< ref "container-schema#liveness-probes" >}}) for more details. - -## Connections - -When a connection is declared from a container to another Radius resource, Radius injects environment variables with connection information to make it easy to access the target resource. These variables can be used by your code to access the resource without manually hard-coding or mounting URIs, connection strings, access keys, or other values. Connection information is securely managed by the Radius Environment, ensuring it is stored and mounted correctly. - -These environment variables follow a naming convention that makes their use predictable. The naming pattern is derived from the connection name and resource type, which determines what values are required. This way the code that needs to read the values gets to define how they are named. Refer to the [reference documentation]({{< ref resource-schema >}}) of each resource for more information. - -For example, adding a connection called `database` that connects to a MongoDB resource would result in the following environment variables being injected: - -| Key | Value | -|-----|-------| -| `CONNECTION_DATABASE_CONNECTIONSTRING` | The connection string to the database | -| `CONNECTION_DATABASE_DATABASE` | Database name of the target database | -| `CONNECTION_DATABASE_USERNAME` | Username of the target database | -| `CONNECTION_DATABASE_PASSWORD` | Password of the target database | - -Alternatively, if you already have another convention you would like to follow or if you just prefer to be explicit, you may ignore the values generated by a connection and instead override it by setting your own environment variable values. - -<!-- For more information on how to add connections, refer to the [connect to dependencies how-to guide]("guides/author-apps/containers/how-to-connect-dependencies"). --> - -## Extensions - -Extensions define additional capabilities and configuration for a container. - -### Kubernetes metadata extension - -The [Kubernetes metadata extension]({{< ref kubernetes-metadata>}}) enables you to configure the Kubernetes metadata for the container. This includes the labels and annotations for the container. Refer to to the extension overview page to get more details about the extension and how it works with other Radius resources. - -### Manual scaling extension - -The manualScaling extension configures the number of replicas of a compute instance (such as a container) to run. Refer to the [container resource schema]({{< ref "container-schema#extensions" >}}) for more details. - -### Dapr sidecar extension - -The `daprSidecar` extensions adds and configures a [Dapr](https://dapr.io) sidecar to your application. Refer to the [container resource schema]({{< ref "container-schema#extensions" >}}) for more details - -## Further reading - -- [Container schema]({{< ref container-schema >}}) diff --git a/docs/content/guides/author-apps/dapr/_index.md b/docs/content/guides/author-apps/dapr/_index.md deleted file mode 100644 index f5744fa90..000000000 --- a/docs/content/guides/author-apps/dapr/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Dapr building blocks" -linkTitle: "Dapr" -description: "Easily leverage Dapr building blocks in your application for code and infrastructure portability" -weight: 500 ---- diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/app-statestore.png b/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/app-statestore.png deleted file mode 100644 index d3f2777be..000000000 Binary files a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/app-statestore.png and /dev/null differ 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 deleted file mode 100644 index 953f4f3cb..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -type: docs -title: "How-To: Add a Dapr building block" -linkTitle: "Add a building block" -description: "Learn how to add a Dapr building block to a Radius Application" -weight: 300 -categories: "How-To" -tags: ["Dapr"] ---- - -This how-to guide will provide an overview of how to: - -- Leverage a [Dapr building block](https://docs.dapr.io/developing-applications/building-blocks/) in your Radius Application - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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/) - -## Step 1: Start with a container and a Dapr sidecar - -Begin by creating a file named `app.bicep` with a defined Radius container and a Dapr sidecar, if you need a in-depth walkthrough see the ['How-To: Add a Dapr sidecar to a container' guide]({{< ref how-to-dapr-sidecar >}}): - -{{< rad file="./snippets/app-sidecar.bicep" embed=true >}} - -## Step 2: Add a Dapr state store resource - -Now add a Dapr state store resource, which models a [Dapr state store component](https://docs.dapr.io/developing-applications/building-blocks/state-management/state-management-overview/). The underlying infrastructure and Dapr component configuration are deployed via a `local-dev` Recipe, which leverages a lightweight Redis container: - -{{< rad file="./snippets/app-statestore.bicep" embed=true marker="//STATESTORE" >}} - -> Visit the [Radius Recipe repo](https://github.com/radius-project/recipes/blob/main/local-dev/statestores.bicep) to learn more about `local-dev` Recipes and view the Dapr State Store Recipe used in this guide. - -## Step 3: Add a connection from the container resource to the Dapr state store resource - -Update your container resource with a connection to the Dapr state store. This will inject important connection information (the component name) into the container's environment variables: - -{{< rad file="./snippets/app-statestore.bicep" embed=true marker="//CONTAINER" >}} -## Step 3: Deploy the application - -Run your application with the `rad` CLI: - -```bash -rad run ./app.bicep -a demo -``` - -Your console output should look similar to: - -``` -Building ./app.bicep... -Deploying template './app.bicep' for application 'demo' and environment 'default' from workspace 'default'... - -Deployment In Progress... - -Completed statestore Applications.Dapr/stateStores -... demo Applications.Core/containers - -Deployment Complete - -Resources: - demo Applications.Core/containers - statestore Applications.Dapr/stateStores - -Starting log stream... -``` - -Open [http://localhost:3000](http://localhost:3000) to view the Radius demo container. Which should contain the following connection information: - -{{< image src="app-statestore.png" alt="Screenshot of the demo Redis connection" width=700px >}} -## Step 4: Verify the Dapr statestore - -Run the command below to see all the pods running in your Kubernetes cluster: - -```bash -dapr components --namespace "default-demo" -k -``` - -The console output should similar to: - -``` -NAMESPACE NAME TYPE VERSION SCOPES CREATED AGE -default-demo statestore state.redis v1 2024-02-19 17:13.20 2m -``` - -## Done - -You've successfully deployed a Radius container with a Dapr sidecar along with a Dapr State Store. With the combination of Radius + Dapr, both your application's code and it's definition are now platform neutral. - -## Cleanup - -To delete your app, run the [rad app delete]({{< ref rad_application_delete >}}) command to cleanup the app and its resources, including the Recipe resources: - -```bash -rad app delete -a demo -``` - -## Further reading - -- [Dapr building blocks](https://docs.dapr.io/concepts/building-blocks-concept/) -- [Dapr resource schemas]({{< ref dapr-schema >}}) - 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 deleted file mode 100644 index afbc9deb7..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-sidecar.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -@description('The ID of your Radius Application. Automatically injected by the rad CLI.') -param application string - -@description('The ID of your Radius environment. Automatically injected by the rad CLI.') -param environment string - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'demo' - appPort: 3000 - } - ] - } -} 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 deleted file mode 100644 index b26010fa6..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-statestore.bicep +++ /dev/null @@ -1,46 +0,0 @@ -extension radius - -@description('The ID of your Radius Application. Automatically injected by the rad CLI.') -param application string - -@description('The ID of your Radius environment. Automatically injected by the rad CLI.') -param environment string - -//CONTAINER -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'demo' - appPort: 3000 - } - ] - connections: { - redis: { - source: stateStore.id - } - } - } -} -//CONTAINER - -//STATESTORE -resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { - name: 'statestore' - properties: { - environment: environment - application: application - } -} -//STATESTORE diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/index.md b/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/index.md deleted file mode 100644 index fa7ccf8d2..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/index.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -type: docs -title: "How-To: Reference secrets in Dapr components" -linkTitle: "Reference secrets in components" -description: "Learn how to manage secrets in Dapr components" -weight: 300 -categories: "How-To" -tags: ["Dapr"] ---- - -This guide will provide an overview of how to: - -- Securely manage secrets in Dapr components using [Dapr secret stores](https://docs.dapr.io/operations/components/setup-secret-store/) - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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/) - -## Step 1: Create a container and a Dapr sidecar - -Begin by creating a file named `app.bicep`, which defines a container with a Dapr state store. If you need a detailed explanation on how to do so, refer to the [Add a Dapr building block]({{< ref how-to-dapr-building-block >}}) tutorial. - -In this guide, you manually provision both a Redis instance and a Dapr state store component. Specify the Redis username in the Dapr state store, which will later be secured using a Dapr Secret Store. - -{{< rad file="./snippets/app-statestore.bicep" embed=true >}} - -Deploy the application with the `rad` CLI: - -```bash -rad run ./app.bicep -a demo-secret -``` - -While the application is running, verify that the `redisUsername` is exposed in the Dapr state store component by running the following command **in another terminal**: -```sh -kubectl -n default-demo-secret get component demo-statestore -o yaml -``` - -The output should look similar to: -```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 -``` - -## Step 2: Add a Dapr secret store resource and create a secret - -Secure the Redis username using a Dapr Secret Store. In your `app.bicep` file, add a Dapr secret store resource. Use the `local-dev` recipe to deploy the secret store, leveraging Kubernetes secrets - -{{< rad file="./snippets/app-statestore-secret.bicep" embed=true marker="//SECRETSTORE" >}} - -> Visit the [Radius Recipe repo](https://github.com/radius-project/recipes/blob/main/local-dev/secretstores.bicep) to learn more about `local-dev` Recipes and view the Dapr Secret Store Recipe used in this guide. - - -Now, create a Kubernetes secret for the Redis username by creating a `redis-auth.yaml` file with the following content: -```yaml -apiVersion: v1 -kind: Secret -metadata: - name: redis-auth - namespace: default-demo-secret -type: opaque -data: - # Result of "echo -n 'default' | base64" - username: ZGVmYXVsdA== -``` - -Apply the secret to your Kubernetes cluster by running: -```sh -kubectl apply -f redis-auth.yaml -``` - -## Step 3: Configure the Dapr state store to use the Dapr secret store - -Finally, update your Dapr state store to reference the created secret. - -{{< rad file="./snippets/app-statestore-secret.bicep" embed=true marker="//STATESTORE" >}} - - -## Step 4: Deploy the updated application - -Deploy the application with the updated configuration: -```bash -rad run ./app.bicep -a demo-secret -``` - -You can verify that the Redis username is no longer exposed by running the following command **in another terminal**: -```sh -kubectl -n default-demo-secret get component demo-statestore -o yaml -``` - -The output should show the Redis username stored in the secret store: -```yaml -apiVersion: dapr.io/v1alpha1 -auth: - secretStore: secretstore -kind: Component -metadata: - name: demo-statestore - namespace: default-demo-secret -spec: - metadata: - - name: redisHost - value: <HOST> - - name: redisUsername - secretKeyRef: - key: username - name: redis-auth - type: state.redis - version: v1 -``` -Open [http://localhost:3000](http://localhost:3000) to view the Radius demo container. The TODO application should work as intended. - -> In a production environment, it's recommended to use a more secure secret store, such as Azure Key Vault or HashiCorp Vault, instead of relying on Kubernetes secrets. You can find the list of all Dapr secret store components [here](https://docs.dapr.io/reference/components-reference/supported-secret-stores/). - -## Cleanup - -To delete your app, run the [rad app delete]({{< ref rad_application_delete >}}) command to cleanup the app and its resources, including the Recipe resources: - -```bash -rad app delete -a demo-secret -kubectl delete secret redis-auth -n default-demo-secret -``` - -## Further reading - -- [Dapr building blocks](https://docs.dapr.io/concepts/building-blocks-concept/) -- [Dapr resource schemas]({{< ref dapr-schema >}}) - diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/snippets/app-statestore-secret.bicep b/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/snippets/app-statestore-secret.bicep deleted file mode 100644 index c86f2a2a5..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/snippets/app-statestore-secret.bicep +++ /dev/null @@ -1,78 +0,0 @@ -extension radius - -@description('The ID of your Radius Application. Automatically injected by the rad CLI.') -param application string - -@description('The ID of your Radius environment. Automatically injected by the rad CLI.') -param environment string - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'demo' - appPort: 3000 - } - ] - connections: { - redis: { - source: stateStore.id - } - } - } -} - -resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview' = { - name: 'demo-redis-manual' - properties: { - environment: environment - application: application - } -} - -resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { - name: 'demo-statestore' - properties: { - // The secret store to pull secret store - auth: { - secretStore: secretstore.name - } - application: application - environment: environment - resourceProvisioning: 'manual' - type: 'state.redis' - version: 'v1' - metadata: { - redisHost: { - value: '${redis.properties.host}:${redis.properties.port}' - } - redisUsername: { - secretKeyRef: { - // Secret object name - name: 'redis-auth' - // Secret key - key: 'username' - } - } - } - } -} - -resource secretstore 'Applications.Dapr/secretStores@2023-10-01-preview' = { - name: 'secretstore' - properties: { - environment: environment - application: application - } -} diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/snippets/app-statestore.bicep b/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/snippets/app-statestore.bicep deleted file mode 100644 index 17544b748..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-secrets/snippets/app-statestore.bicep +++ /dev/null @@ -1,63 +0,0 @@ -extension radius - -@description('The ID of your Radius Application. Automatically injected by the rad CLI.') -param application string - -@description('The ID of your Radius environment. Automatically injected by the rad CLI.') -param environment string - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'demo' - appPort: 3000 - } - ] - connections: { - redis: { - source: stateStore.id - } - } - } -} - -resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview' = { - name: 'demo-redis-manual' - properties: { - environment: environment - application: application - } -} - -resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { - name: 'demo-statestore' - properties: { - application: application - environment: environment - resourceProvisioning: 'manual' - type: 'state.redis' - version: 'v1' - metadata: { - redisHost: { - value: '${redis.properties.host}:${redis.properties.port}' - } - // This value will be considered a secret later on - redisUsername: { - value: 'default' - } - } - } -} - diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/index.md b/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/index.md deleted file mode 100644 index 9f8f1c831..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -type: docs -title: "How-To: Add a Dapr sidecar to a container" -linkTitle: "Add a Dapr sidecar" -description: "Learn how to add a Dapr sidecar to a Radius container" -weight: 200 -categories: "How-To" -tags: ["Dapr"] ---- - -This how-to guide will provide an overview of how to: - -- Leverage a [Dapr sidecar](https://docs.dapr.io/concepts/dapr-services/sidecar/) with your Radius Application - -## Prerequisites - -- [Supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-kubernetes-clusters" >}}) -- rad CLI -- [Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/) -- [Radius initialized with `rad init`]({{< ref howto-environment >}}) -- [Dapr initialized with `dapr init -k`](https://docs.dapr.io/getting-started/install-dapr-selfhost/) - -## Step 1: Start with a container - -Begin by creating a file named `app.bicep` with a Radius [container]({{< ref "guides/author-apps/containers" >}}): - -{{< rad file="snippets/app.bicep" embed=true >}} - -## Step 2: Add a Dapr sidecar extension - -Now add the Dapr sidecar extension, which enabled Dapr and adds a Dapr sidecar: - -{{< rad file="snippets/app-sidecar.bicep" embed=true marker="//CONTAINER" >}} - -## Step 3: Deploy the app - -Deploy your application: - -```bash -rad deploy ./app.bicep -a demo -``` - -Your console output should look similar to: - -``` -Building ./app.bicep... -Deploying template './app.bicep' for application 'demo' and environment 'default' from workspace 'default'... -Deployment In Progress... -... demo Applications.Core/containers -Deployment Complete -Resources: - demo Applications.Core/containers -``` - -## Step 4: Verify the Dapr sidecar - -Run `dapr list -k` to list all Dapr pods in your Kubernetes cluster: - -```bash -dapr list -k -``` - - -The console output should look similar to: - -``` -NAMESPACE APP ID APP PORT AGE CREATED -default-demo demo 3000 29s 2023-11-30 21:52.59 -``` - -## Done - -You've successfully deployed a Radius container with a Dapr sidecar! You can now interact with Dapr building blocks and the Dapr API from your container. - - -## Cleanup - -Run the following command to [delete]({{< ref "guides/deploy-apps/howto-delete" >}}) your app and container: - - ```bash - rad app delete -a demo - ``` - -## Further reading - -- [Radius Dapr tutorial]({{< ref "reference/samples/tutorial-dapr" >}}) -- [Dapr in Radius containers]({{< ref "guides/author-apps/containers/overview#kubernetes" >}}) -- [Dapr sidecar schema]({{< ref "reference/resource-schema/dapr-schema/dapr-extension" >}}) \ No newline at end of file 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 deleted file mode 100644 index e5407de9a..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app-sidecar.bicep +++ /dev/null @@ -1,23 +0,0 @@ -extension radius - -@description('The ID of your Radius Application. Automatically injected by the rad CLI.') -param application string - -//CONTAINER -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'demo' - appPort: 3000 - } - ] - } -} -//CONTAINER 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 deleted file mode 100644 index c4b628010..000000000 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app.bicep +++ /dev/null @@ -1,14 +0,0 @@ -extension radius - -@description('The ID of your Radius Application. Automatically injected by the rad CLI.') -param application string - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - } - } -} diff --git a/docs/content/guides/author-apps/dapr/overview/dapr-buildingblocks.png b/docs/content/guides/author-apps/dapr/overview/dapr-buildingblocks.png deleted file mode 100644 index 02116ce62..000000000 Binary files a/docs/content/guides/author-apps/dapr/overview/dapr-buildingblocks.png and /dev/null differ diff --git a/docs/content/guides/author-apps/dapr/overview/dapr-sidecar.png b/docs/content/guides/author-apps/dapr/overview/dapr-sidecar.png deleted file mode 100644 index 84b483de4..000000000 Binary files a/docs/content/guides/author-apps/dapr/overview/dapr-sidecar.png and /dev/null differ diff --git a/docs/content/guides/author-apps/dapr/overview/index.md b/docs/content/guides/author-apps/dapr/overview/index.md deleted file mode 100644 index c26f7668e..000000000 --- a/docs/content/guides/author-apps/dapr/overview/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -type: docs -title: "Overview: Dapr building blocks" -linkTitle: "Overview" -description: "Easily leverage Dapr building blocks in your application for code and infrastructure portability" -weight: 100 -categories: "Overview" -tags: ["Dapr"] ---- - -Radius offers first-class support for the [Dapr](https://dapr.io) runtime and building blocks to make it easy to make your code fully portable across code and infrastructure. Simply drop in your Dapr building blocks as resources and Radius will automatically configure and apply the accompanying Dapr configuration. - -## Installation - -Follow the [Dapr installation instructions](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/) to install Dapr in your Kubernetes cluster. Once installed, you can begin adding Dapr sidecars and building blocks. - -{{< button text="Setup Dapr" link="https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/" newtab="true" >}} - -## Sidecar - -A [Dapr sidecar](https://docs.dapr.io/concepts/dapr-services/sidecar/) allows your services to interact with Dapr building blocks. It is required if your service leverages Dapr. - -{{< image src="dapr-sidecar.png" style="width:600px" alt="Diagram of the Dapr sidecar" >}} <br /> - -You can easily add the Dapr sidecar to your [Containers]({{< ref "guides/author-apps/containers" >}}) using a Dapr sidecar extension: - -{{< tabs Bicep >}} - -{{% codetab %}} -{{< rad file="snippets/sidecar.bicep" embed=true marker="//CONTAINER" >}} -{{% /codetab %}} - -{{< /tabs >}} - -Your container can now interact with the sidecar using the Dapr [building block APIs](https://docs.dapr.io/concepts/building-blocks-concept/) or the [Dapr SDKs](https://docs.dapr.io/developing-applications/sdks/). - -## Building blocks - -Dapr resources make it easy to model and configure [Dapr building block APIs](https://docs.dapr.io/developing-applications/building-blocks/). Simply specify the building block and the backing resource, and Radius will apply the accompanying Dapr component configuration. - -{{< image src="dapr-buildingblocks.png" style="width:1000px" alt="Diagram of all the Dapr building blocks" >}} <br /> - -Model your building blocks as resources: - -{{< tabs Bicep >}} - -{{< codetab >}} -{{< rad file="snippets/statestore.bicep" embed=true marker="//STATESTORE" >}} -{{< /codetab >}} - -{{< /tabs >}} - -### Component naming - -To interact with a Dapr building block, you need to know the name of the [Dapr component](https://docs.dapr.io/concepts/components-concept/). This name is the same as the name of the building block resource. - -For example, if you have a `Applications.Dapr/stateStores` resource named `mystatestore` the Dapr component name will be `mystatestore`. Your code will then interact with this component via `http://localhost:3500/v1.0/state/mystatestore`, or via the Dapr SDKs through the `mystatestore` component name. - -### Connecting to Dapr building blocks - -You can connect to a Dapr building block by manually referencing the resource name or by adding a connection. Connections automatically inject environment variables into your container with the resource name prefixed. - -{{< rad file="snippets/dapr-componentname.bicep" embed=true marker="//MARKER" replace-key-ss="//STATESTORE" replace-value-ss="resource statestore 'Applications.Dapr/stateStores@2023-10-01-preview' = {...}" >}} - -### Service invocation - -Dapr [service invocation](https://docs.dapr.io/developing-applications/building-blocks/service-invocation/service-invocation-overview/) allows your services to discover and call each other. - -One container in an application can invoke another using the `AppId`. - -{{< tabs Bicep >}} - -{{< codetab >}} -{{< rad file="snippets/service-invocation.bicep" embed=true marker="//INVOKE" >}} -{{< /codetab >}} - -{{< /tabs >}} - -## Resource schema - -Refer to the [schema reference docs]({{< ref dapr-schema >}}) for more information on how to model Dapr resources. 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 deleted file mode 100644 index 301a0aeaf..000000000 --- a/docs/content/guides/author-apps/dapr/overview/snippets/dapr-componentname.bicep +++ /dev/null @@ -1,74 +0,0 @@ -extension radius - -param environment string - -resource account 'Microsoft.Storage/storageAccounts@2019-06-01' existing = { - name: 'myaccount' - - resource tableServices 'tableServices' existing = { - name: 'default' - - resource table 'tables' existing = { - name: 'mytable' - } - } -} - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//MARKER -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'mycontainer' - properties: { - application: app.id - container: { - image: 'myimage' - env: { - // Option 1: Manually set component name as an environment variable - DAPR_COMPONENTNAME: { - value: statestore.name - } - } - } - connections: { - // Option 2 (preferred): Automatically set environment variable with component name - c1: { - source: statestore.id // Results in CONNECTION_C1_COMPONENTNAME - } - } - } -} - -//STATESTORE -resource statestore 'Applications.Dapr/stateStores@2023-10-01-preview' = { - name: 'mystatestore' - properties: { - environment: environment - application: app.id - resourceProvisioning: 'manual' - resources: [ - { id: account.id } - { id: account::tableServices::table.id } - ] - metadata: { - accountName: { - value: account.name - } - accountKey: { - value: account.listKeys().keys[0].value - } - tableName: { - value: account::tableServices::table.name - } - } - type: 'state.azure.tablestorage' - version: 'v1' - } -} -//STATESTORE -//MARKER 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 deleted file mode 100644 index 1e8b3c565..000000000 --- a/docs/content/guides/author-apps/dapr/overview/snippets/service-invocation.bicep +++ /dev/null @@ -1,47 +0,0 @@ -extension radius - - -resource app 'Applications.Core/applications@2023-10-01-preview' existing = { - name: 'myapp' -} - -// Backend is being invoked through service invocation -resource backend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'backend' - properties: { - application: app.id - container: { - image: 'backend:latest' - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'backend' - } - ] - } -} - - -// Frontend invokes backend -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: app.id - container: { - image: 'frontend:latest' - env: { - // Configures the appID of the backend service. - CONNECTION_BACKEND_APPID: { - value: 'backend' - } - } - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'frontend' - } - ] - } -} diff --git a/docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep deleted file mode 100644 index 04a80a4c3..000000000 --- a/docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//CONTAINER -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'mycontainer' - properties: { - application: app.id - container: { - image: 'myimage' - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'mycontainer' - appPort: 3500 - } - ] - } -} -//CONTAINER diff --git a/docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep deleted file mode 100644 index 0ba97d53b..000000000 --- a/docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep +++ /dev/null @@ -1,52 +0,0 @@ -extension radius - -param environment string - - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//STATESTORE -resource account 'Microsoft.Storage/storageAccounts@2019-06-01' existing = { - name: 'myaccount' - - resource tableServices 'tableServices' existing = { - name: 'default' - - resource table 'tables' existing = { - name: 'mytable' - } - } -} - -// The accompanying Dapr component resource is automatically created for you -resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { - name: 'mystatestore' - properties: { - environment: environment - application: app.id - resourceProvisioning: 'manual' - resources: [ - { id: account.id } - { id: account::tableServices::table.id } - ] - metadata: { - accountName: { - value: account.name - } - accountKey: { - value: account.listKeys().keys[0].value - } - tableName: { - value: account::tableServices::table.name - } - } - type: 'state.azure.tablestorage' - version: 'v1' - } -} -//STATESTORE diff --git a/docs/content/guides/author-apps/kubernetes/_index.md b/docs/content/guides/author-apps/kubernetes/_index.md deleted file mode 100644 index dbc77129d..000000000 --- a/docs/content/guides/author-apps/kubernetes/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Kubernetes resources" -linkTitle: "Kubernetes" -description: "Deploy and connect to Kubernetes resources in your application" -weight: 600 ---- \ No newline at end of file diff --git a/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/index.md b/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/index.md deleted file mode 100644 index 3cee7bbc8..000000000 --- a/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/index.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -type: docs -title: "How-To: Access Kubernetes secrets using PodSpec" -linkTitle: "Secrets using PodSpec" -description: "Learn how to patch Kubernetes secrets into the container environment using PodSpec definitions" -weight: 300 -slug: 'secrets-podspec' -categories: "How-To" -tags: ["containers","Kubernetes", "secrets"] ---- - -This how-to guide will provide an overview of how to: - -- Patch existing Kubernetes secrets using [PodSpec](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec) definitions and provide them to the environment of a container. - -## Prerequisites - -- rad CLI -- [Radius initialized with `rad init`]({{< ref howto-environment >}}) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - -## Step 1: Define a container - -Begin by creating a file named `app.bicep` with a Radius [container]({{< ref "guides/author-apps/containers" >}}): - -{{< rad file="snippets/secrets-container.bicep" embed=true >}} - -## Step 2: Deploy the app and container - -Run this command to deploy the app and container: - -```bash -rad run ./app.bicep -a demo -``` - -Once the deployment completes successfully, you should see the following confirmation message along with some system logs: - -``` -Building app.bicep... -Deploying template 'app.bicep' for application 'demo' and environment 'dev' from workspace 'dev'... - -Deployment In Progress... - -.. demo Applications.Core/containers -Completed demo Applications.Core/applications - -Deployment Complete - -Resources: - demo Applications.Core/applications - demo Applications.Core/containers - -Starting log stream... - -+ demo-7d94db59f6-ps6cf β€Ί demo -demo-7d94db59f6-ps6cf demo No APPLICATIONINSIGHTS_CONNECTION_STRING found, skipping Azure Monitor setup -demo-7d94db59f6-ps6cf demo Using in-memory store: no connection string found -demo-7d94db59f6-ps6cf demo Server is running at http://localhost:3000 -dashboard-7f7db87c5-7d2jf dashboard [port-forward] connected from localhost:7007 -> ::7007 -demo-7d94db59f6-ps6cf demo [port-forward] connected from localhost:3000 -> ::3000 -``` - -Verify the pod is running: - -```bash -kubectl get pods -n dev-demo -``` -You should see the following output in your console: -``` -NAME READY STATUS RESTARTS AGE -demo-7d94db59f6-k7dfb 1/1 Running 0 62s -``` - -## Step 3: Create a secret - -Create a secret in your Kubernetes cluster using the following command: - -```bash -kubectl create secret generic my-secret --from-literal=secret-key=secret-value -n dev-demo -``` - -Verify the secret is created: - -```bash -kubectl get secrets -n dev-demo -``` - -## Step 4: Patch the secret - -Patch the secret into the container by adding the following `runtimes` block to the `container` resource in your `app.bicep` file: - -{{< rad file="snippets/secrets-patch.bicep" embed=true markdownConfig="{linenos=table,hl_lines=[\"25-60\"]}" >}} - -## Step 5: Redeploy the app and container - -Redeploy and run your app: - -```bash -rad app deploy demo -``` - -Once the deployment completes successfully, you should see the environment variable in the container. - -To validate this, first get the pod name: - -```bash -kubectl get pods -n dev-demo -``` - -You should see the following output in your console, with the pod name: -``` -NAME READY STATUS RESTARTS AGE -demo-d64cc4d6d-xjnjz 1/1 Running 0 62s -``` - -Then, exec into the pod and check the environment variable (substitute the pod name with the one you got from the previous command): - -{{< tabs "macOS/Linux/WSL" "Windows" >}} - -{{% codetab %}} - -```bash -kubectl -n dev-demo exec demo-d64cc4d6d-xjnjz -- env | grep MY_SECRET -``` - -{{% /codetab %}} - -{{% codetab %}} - -```powershell -kubectl -n dev-demo exec demo-d64cc4d6d-xjnjz -- env | findstr MY_SECRET -``` - -{{% /codetab %}} - -{{< /tabs >}} - -## Cleanup - -Run the following command to [delete]({{< ref "guides/deploy-apps/howto-delete" >}}) your app and container: - -```bash -rad app delete demo -``` - -## Further reading - -- [Kubernetes in Radius containers]({{< ref "guides/author-apps/containers/overview#kubernetes" >}}) -- [PodSpec in Radius containers]({{< ref "reference/resource-schema/core-schema/container-schema#runtimes" >}}) \ No newline at end of file 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 deleted file mode 100644 index 225ed1d51..000000000 --- a/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-container.bicep +++ /dev/null @@ -1,26 +0,0 @@ -extension radius - -@description('Specifies the environment for resources.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'demo' - properties: { - environment: environment - } -} - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - } -} 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 deleted file mode 100644 index 9d8eff55d..000000000 --- a/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-patch.bicep +++ /dev/null @@ -1,62 +0,0 @@ -extension radius - -@description('Specifies the environment for resources.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'demo' - properties: { - environment: environment - } -} - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - runtimes: { - kubernetes: { - pod: { - volumes: [ { - name: 'secrets-vol' - secret: { - secretName: 'my-secret' - } - } - ] - containers: [ - { - name: 'demo' - volumeMounts: [ { - name: 'secrets-vol' - readOnly: true - mountPath: '/etc/secrets-vol' - } - ] - env: [ - { - name: 'MY_SECRET' - valueFrom: { - secretKeyRef: { - name: 'my-secret' - key: 'secret-key' - } - } - } - ] - } - ] - hostNetwork: true - } - } - } - } -} diff --git a/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/demo-secret-object.png b/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/demo-secret-object.png deleted file mode 100644 index 667df3696..000000000 Binary files a/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/demo-secret-object.png and /dev/null differ diff --git a/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/index.md b/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/index.md deleted file mode 100644 index 0e3fa11da..000000000 --- a/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/index.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -type: docs -title: "How-To: Use Kubernetes resources in your application" -linkTitle: "Add Kubernetes resources" -description: "Learn how to use Kubernetes resources in your application" -weight: 200 -categories: "How-To" -tags: ["Kubernetes"] ---- - -This how-to guide will provide an overview of how to: - -- Leverage Kubernetes resources in your Radius Application directly. - -## Prerequisites - -- rad CLI -- [Radius initialized with `rad init`]({{< ref howto-environment >}}) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - -## Step 1: Define the Kubernetes provider - -Begin by creating a new file named `app.bicep`. At the top of your file, import the `kubernetes` provider and add its configuration. This allows you to define and deploy Kubernetes resources within Bicep. -- The `namespace` property determines where to deploy Kubernetes resources by default. -- The `kubeConfig` property is not currently used and can remain as an empty string (`''`): - -{{< rad file="snippets/app-kubernetes.bicep" embed=true marker="//KUBERNETES" >}} - -## Step 2: Add a Kubernetes secret resource - -Add a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) to your `app.bicep` file. This secret will contain a small amount of sensitive data such as a password, a token, or a key: - -{{< rad file="snippets/app-kubernetes.bicep" embed=true marker="//SECRET" >}} - -> Refer to the [Kubernetes overview page]({{< ref "/guides/author-apps/kubernetes/overview#resource-library" >}}) for additional information about available types. - -## Step 3: Add a container and use the secret you just defined - -Add a Radius [container]({{< ref "guides/author-apps/containers" >}}) to your application: - -{{< rad file="snippets/app-kubernetes.bicep" embed=true marker="//APPLICATION" >}} - -## Step 4: Deploy your Radius Application - -Deploy your application with the `rad` CLI: - -```bash -rad run ./app.bicep -a demo -``` - -Your console output should look similar to: - -``` -Building ./app.bicep... -Deploying template './app.bicep' for application 'demo' and environment 'default' from workspace 'default'... - -Deployment In Progress... - -... demo Applications.Core/containers - -Deployment Complete - -Resources: - demo Applications.Core/containers - -Starting log stream... -``` - -Open [http://localhost:3000](http://localhost:3000) to view the Radius demo container. Then navigate to the `Container Metadata` tab and the `Environment variables` section which are located near the bottom of the Radius demo webpage, there will be row dedicated to your Kubernetes secret object: - -{{< image src="demo-secret-object.png" alt="Screenshot of Radius Demo app `Environment variables section" width="700px" >}} - -You can also prove the deployed Kubernetes secret was created by using `kubectl`, and running the following command with your specific secret name: - -```bash -kubectl describe secret my-secret -n default-demo -``` - -Your console output should contain the following section: - -``` -Name: my-secret -Namespace: default-demo -Labels: <none> -Annotations: <none> - -Type: Opaque - -Data -==== -my-secret-key: 15 bytes -``` - -## Cleanup - -To delete your Radius specific Kubernetes resources you'll need to run: - -```bash -rad app delete -a demo -``` - -Once your Radius Application has been deleted you can delete the Kubernetes Secret: - -```bash -kubectl delete secret my-secret -n default-demo -``` - -Your console output should look similar to: - -``` -secret "my-secret" deleted -``` - -> [`rad app delete`]({{< ref rad_application_delete >}}) does not delete non-Radius resources that are not directly part of a Radius Application, such as Kubernetes resources. These resources require an additional cleanup step. - -## Further reading - -- [Kubernetes in Radius containers]({{< ref "guides/author-apps/containers/overview#kubernetes" >}}) 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 deleted file mode 100644 index 5ccca757a..000000000 --- a/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/snippets/app-kubernetes.bicep +++ /dev/null @@ -1,48 +0,0 @@ -//KUBERNETES -@description('Specifies Kubernetes namespace for the user.') -param namespace string = 'default-demo' - -extension kubernetes with { - kubeConfig: '' - namespace: namespace -} -//KUBERNETES - -//APPLICATION -// Import the set of Radius resources (Applications.*) into Bicep -extension radius - -@description('The app ID of your Radius Application. Set automatically by the rad CLI.') -param application string - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - env: { - SECRET: { - value: base64ToString(secret.data['my-secret-key']) - } - } - } - } -} -//APPLICATION - -//SECRET -resource secret 'core/Secret@v1' = { - metadata: { - name: 'my-secret' - } - stringData: { - 'my-secret-key': 'my-secret-value' - } -} -//SECRET diff --git a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/demoapp-howtopatchpod.png b/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/demoapp-howtopatchpod.png deleted file mode 100644 index 4d3330752..000000000 Binary files a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/demoapp-howtopatchpod.png and /dev/null differ diff --git a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/index.md b/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/index.md deleted file mode 100644 index 0b3248a08..000000000 --- a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/index.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -type: docs -title: "How-To: Patch Kubernetes resources using PodSpec" -linkTitle: "Patch using PodSpec" -description: "Learn how to patch Kubernetes resources using PodSpec definitions" -weight: 300 -slug: 'patch-podspec' -categories: "How-To" -tags: ["containers","Kubernetes"] ---- - -This how-to guide will provide an overview of how to: - -- Patch Radius-created Kubernetes resources using [PodSpec](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec) definitions - -## Prerequisites - -- rad CLI -- [Radius initialized with `rad init`]({{< ref howto-environment >}}) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - -## Step 1: Define a container - -Begin by creating a file named `app.bicep` with a Radius [container]({{< ref "guides/author-apps/containers" >}}): - -{{< rad file="snippets/patch-container.bicep" embed=true >}} - -## Step 2: Deploy the app and container - -1. Deploy and run your app: - - ```bash - rad run ./app.bicep -a demo - ``` - - Once the deployment completes successfully, you should see the following confirmation message along with some system logs: - - ``` - Deployment Complete - - Resources: - demo Applications.Core/applications - demo Applications.Core/containers - - Starting log stream... - - + demo-df76d886c-sngm8 β€Ί demo - demo-df76d886c-sngm8 demo Using in-memory store: no connection string found - demo-df76d886c-sngm8 demo Server is running at http://localhost:3000 - demo-df76d886c-sngm8 demo [port-forward] connected from localhost:3000 -> ::3000 - ``` - - Access the application by opening [http://localhost:3000](http://localhost:3000) in a browser, where you should see the demo app: - - <img src="./demoapp-howtopatchpod.png" alt="Screenshot of Radius Demo app" width="600"/> - - <br> When you're ready to move on to the next step, use `CTRL` + `C` to exit the command. - -1. Run the command below, which will list the pods in your Kubernetes cluster, using the `-o` flag to specify the relevant information to output: - - ```bash - kubectl get pods -A -l app.kubernetes.io/name=demo -o custom-columns=POD:.metadata.name,STATUS:.status.phase,CONTAINER_NAMES:spec.containers[:].name,CONTAINER_IMAGES:spec.containers[:].image - ``` - - You should see output confirming that a single container named `demo` was deployed and is running in your pod, similar to the following: - - ``` - POD STATUS CONTAINER_NAMES CONTAINER_IMAGES - demo-df76d886c-9p4gv Running demo ghcr.io/radius-project/samples/demo:latest - ``` - -## Step 3: Add a PodSpec to the container definition - -Add the following [`runtimes`]({{< ref "reference/resource-schema/core-schema/container-schema#runtimes" >}}) configuration to the container definition in your `app.bicep` file. This allows you to punch through the Radius abstraction and directly apply any part of the Kubernetes PodSpec. In this example you're adding an additional sidecar container: - -{{< rad file="snippets/patch-runtime.bicep" embed=true markdownConfig="{linenos=table,hl_lines=[\"25-37\"]}" >}} - -> Remember to save your `app.bicep` file after you've made the above changes. - -## Step 4: Redeploy your app with the PodSpec added - -1. Deploy and run your app again: - - ```bash - rad run ./app.bicep -a demo - ``` - - Once the deployment completes successfully, you should see the same deployment completion confirmation message as before, but this time with some system logs from `log-collector` streaming to your console output: - - ``` - Starting log stream... - - + demo-547d7dc77f-nmqpk β€Ί log-collector - + demo-547d7dc77f-nmqpk β€Ί demo - demo-547d7dc77f-nmqpk log-collector Fluent Bit v2.1.8 - demo-547d7dc77f-nmqpk log-collector * Copyright (C) 2015-2022 The Fluent Bit Authors - demo-547d7dc77f-nmqpk log-collector * Fluent Bit is a CNCF sub-project under the umbrella of Fluentd - demo-547d7dc77f-nmqpk log-collector * https://fluentbit.io - demo-547d7dc77f-nmqpk log-collector - ``` - - Access the application by opening [http://localhost:3000](http://localhost:3000) in a browser, where you should see the demo app again unchanged from before: - - <img src="./demoapp-howtopatchpod.png" alt="Screenshot of Radius Demo app" width="600"/> - - <br> When you're ready to move on to the next step, use `CTRL` + `C` to exit the command. - -1. Run the command below, which will list the pods in your Kubernetes cluster, using the `-o` flag to specify the relevant information to output: - - ```bash - kubectl get pods -A -l app.kubernetes.io/name=demo -o custom-columns=POD:.metadata.name,STATUS:.status.phase,CONTAINER_NAMES:spec.containers[:].name,CONTAINER_IMAGES:spec.containers[:].image - ``` - - You should now see in the output the original `demo` app container as before, but also an additional `log-collector` container that is running in your pod, similar to the following: - - ``` - POD STATUS CONTAINER_NAMES CONTAINER_IMAGES - demo-547d7dc77f-nmqpk Running log-collector,demo ghcr.io/radius-project/fluent-bit:2.1.8,radius.azurecr.io/tutorial/webapp:latest - ``` - - Note that you might see old pods with a state of `Terminating` in the output - this is normal and you should see them disappear once the redeployment completes cleaning up the old resources. - - The `log-collector` container was deployed using the PodSpec definition you added to your `app.bicep` file in the `runtimes` property you added, and is now running alongside your original `demo` app container. - -## Cleanup - -Run the following command to [delete]({{< ref "guides/deploy-apps/howto-delete" >}}) your app and container: - - ```bash - rad app delete demo - ``` - -## Further reading - -- [Kubernetes in Radius containers]({{< ref "guides/author-apps/containers/overview#kubernetes" >}}) -- [PodSpec in Radius containers]({{< ref "reference/resource-schema/core-schema/container-schema#runtimes" >}}) \ No newline at end of file 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 deleted file mode 100644 index 225ed1d51..000000000 --- a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-container.bicep +++ /dev/null @@ -1,26 +0,0 @@ -extension radius - -@description('Specifies the environment for resources.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'demo' - properties: { - environment: environment - } -} - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - } -} 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 deleted file mode 100644 index a90ac38d7..000000000 --- a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-runtime.bicep +++ /dev/null @@ -1,39 +0,0 @@ -extension radius - -@description('Specifies the environment for resources.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'demo' - properties: { - environment: environment - } -} - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - runtimes: { - kubernetes: { - pod: { - containers: [ - { - name: 'log-collector' - image: 'ghcr.io/radius-project/fluent-bit:2.1.8' - } - ] - hostNetwork: true - } - } - } - } -} diff --git a/docs/content/guides/author-apps/kubernetes/overview/index.md b/docs/content/guides/author-apps/kubernetes/overview/index.md deleted file mode 100644 index ff30b2b38..000000000 --- a/docs/content/guides/author-apps/kubernetes/overview/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -type: docs -title: "Overview: Kubernetes resources" -linkTitle: "Overview" -description: "Deploy and connect to Kubernetes resources in your application" -weight: 100 -categories: "Overview" -tags: ["Kubernetes"] ---- - -Radius Applications are able to connect to and leverage Kubernetes resources. - -## Resource library - -Visit [GitHub](https://github.com/Azure/bicep-types-k8s/tree/main/generated) to reference the Kubernetes resource. - -{{< button text="Kubernetes resource library" link="https://github.com/Azure/bicep-types-k8s/tree/main/generated" newtab="true" >}} - -## Example - -{{< tabs Bicep >}} - -{{% codetab %}} -{{< rad file="snippets/kubernetes-connection.bicep" embed=true >}} -{{% /codetab %}} - -{{< /tabs >}} 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 deleted file mode 100644 index ff6b76a6c..000000000 --- a/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-connection.bicep +++ /dev/null @@ -1,38 +0,0 @@ -extension kubernetes with { - kubeConfig: '' - namespace: 'default' -} -extension radius - -param environment string - -resource secret 'core/Secret@v1' = { - metadata: { - name: 'mysecret' - } - stringData: { - key: 'value' - } -} - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'mycontainer' - properties: { - application: app.id - container: { - image: 'nginx:latest' - env: { - SECRET: { - value: base64ToString(secret.data.key) - } - } - } - } -} 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 deleted file mode 100644 index 9000378ac..000000000 --- a/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-resource.bicep +++ /dev/null @@ -1,23 +0,0 @@ -extension kubernetes with { - kubeConfig: '****' - namespace: 'default' -} - -resource pod 'core/Pod@v1' = { - metadata: { - name: 'mypod' - } - spec: { - containers: [ - { - name: 'web-server' - image: 'nginx:latest' - ports: [ - { - containerPort: 80 - } - ] - } - ] - } -} diff --git a/docs/content/guides/author-apps/networking/_index.md b/docs/content/guides/author-apps/networking/_index.md deleted file mode 100644 index f0ed3df8b..000000000 --- a/docs/content/guides/author-apps/networking/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Application networking" -linkTitle: "Networking" -description: "Learn how to add networking to your Radius Application" -weight: 300 ---- diff --git a/docs/content/guides/author-apps/networking/howto-gateways/demo-screenshot.png b/docs/content/guides/author-apps/networking/howto-gateways/demo-screenshot.png deleted file mode 100644 index 81a3c1dcc..000000000 Binary files a/docs/content/guides/author-apps/networking/howto-gateways/demo-screenshot.png and /dev/null differ diff --git a/docs/content/guides/author-apps/networking/howto-gateways/index.md b/docs/content/guides/author-apps/networking/howto-gateways/index.md deleted file mode 100644 index aa053a75a..000000000 --- a/docs/content/guides/author-apps/networking/howto-gateways/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -type: docs -title: "How To: Configure a gateway for routing internet traffic" -linkTitle: "Gateways" -description: "Learn how to expose a service to the internet via a gateway" -weight: 300 -slug: 'gateways' -categories: "How-To" ---- - -This guide will walk you through how to setup a gateway for routing internet traffic to a service. - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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 - -Begin by defining the service you wish to expose to the internet in a new file named `app.bicep`. This example uses the Radius demo container: - -{{< rad file="snippets/app.bicep" embed=true marker="//FRONTEND" >}} - -## Step 2: Add a gateway - -Next, add a gateway to `app.bicep`, routing traffic to the root path ("/") to the frontend container. Note that when a hostname is not specified one is generated automatically. - -{{< rad file="snippets/app.bicep" embed=true marker="//GATEWAY" >}} - -## Step 3: Deploy the app - -Deploy the application with [`rad deploy`]({{< ref "rad_run" >}}): - -```bash -rad deploy app.bicep -a gatewaydemo -``` - -The gateway endpoint will be printed at the end of the deployment: - -``` -Building app.bicep... - Deploying template './app.bicep' for application 'gatewaydemo' and environment 'default' from workspace 'default'... - - Deployment In Progress... - - Completed gateway Applications.Core/gateways - Completed frontend Applications.Core/containers - - Deployment Complete - - Resources: - gateway Applications.Core/gateways - frontend Applications.Core/containers - - Public endpoint http://1.1.1.1.nip.io/ -``` - -## Step 4: Interact with the application - -Visit the endpoint to interact with the demo Radius container: - -{{< image src="demo-screenshot.png" alt="Screenshot of the demo application" width="500px" >}} - -## Done - -Cleanup the application with ['rad app delete']({{< ref rad_application_delete >}}): - -```bash -rad app delete gatewaydemo -y -``` - -## Further reading - -- [Networking overview]({{< ref "/guides/author-apps/networking/overview" >}}) -- [Gateway reference]({{< ref "/reference/resource-schema/core-schema/gateway" >}}) 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 deleted file mode 100644 index b66ab9d99..000000000 --- a/docs/content/guides/author-apps/networking/howto-gateways/snippets/app.bicep +++ /dev/null @@ -1,36 +0,0 @@ -//FRONTEND -extension radius - -@description('The application ID being deployed. Injected automtically by the rad CLI') -param application string - -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - } -} -//FRONTEND - -//GATEWAY -resource gateway 'Applications.Core/gateways@2023-10-01-preview' = { - name: 'gateway' - properties: { - application: application - routes: [ - { - path: '/' - destination: 'http://${frontend.name}:3000' - } - ] - } -} -//GATEWAY diff --git a/docs/content/guides/author-apps/networking/howto-service-networking/backend-connection.png b/docs/content/guides/author-apps/networking/howto-service-networking/backend-connection.png deleted file mode 100644 index 65868c289..000000000 Binary files a/docs/content/guides/author-apps/networking/howto-service-networking/backend-connection.png and /dev/null differ 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 deleted file mode 100644 index ab69526d7..000000000 --- a/docs/content/guides/author-apps/networking/howto-service-networking/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -type: docs -title: "How To: Service to service networking" -linkTitle: "Service networking" -description: "Learn how your Radius services can communicate with each other" -weight: 200 -slug: 'service-networking' -categories: "How-To" ---- - -This guide will show you how two services can communicate with each other. In this example, we will have a frontend container service that communicates with a backend container service. - -{{< image src="overview.png" alt="Diagram of the frontend talking to the backend over HTTP port 80" width="400px" >}} - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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 - -First, define the containers in a file named `app.bicep`. We will define two services: `frontend` and `backend`: - -{{< rad file="snippets/1-app.bicep" embed=true markdownConfig="{linenos=table}" >}} - -Note the frontend container doesn't yet have a connection to the backend container. We will add that in the next step. - -## Step 2: Add a connection - -With the services defined, we can now add the connection between them. Add a connection to `frontend`: - -{{< rad file="snippets/2-app.bicep" embed=true marker="//FRONTEND" markdownConfig="{linenos=table,hl_lines=[\"14-18\"],linenostart=5}" >}} - -## Step 3: Deploy the application - -Deploy the application using the `rad deploy` command: - -```bash -rad run app.bicep -a networking-demo -``` - -You should see the application deploy successfully and the log stream start: - -``` -Building app.bicep... -Deploying template 'app.bicep' for application 'networking-demo' and environment 'default' from workspace 'default'... - -Deployment In Progress... - -Completed backend Applications.Core/containers -Completed frontend Applications.Core/containers - -Deployment Complete - -Resources: - backend Applications.Core/containers - frontend Applications.Core/containers - -Starting log stream... -``` - -## Step 4: Test the connection - -Visit [http://localhost:3000](http://localhost:3000) in your browser. You should see a connection to the backend container, along with the environment variables that have automatically been set on the frontend container: - -{{< image src="backend-connection.png" alt="Screenshot of the demo container showing the backend connections" width="600px" >}} - -## Done - -You have successfully added a connection between two containers. Make sure to delete your application to clean up the containers: - -```bash -rad app delete networking-demo -y -``` diff --git a/docs/content/guides/author-apps/networking/howto-service-networking/overview.png b/docs/content/guides/author-apps/networking/howto-service-networking/overview.png deleted file mode 100644 index 0c840b052..000000000 Binary files a/docs/content/guides/author-apps/networking/howto-service-networking/overview.png and /dev/null differ 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 deleted file mode 100644 index 9a9beb278..000000000 --- a/docs/content/guides/author-apps/networking/howto-service-networking/snippets/1-app.bicep +++ /dev/null @@ -1,34 +0,0 @@ -extension radius - -@description('The application ID of the Radius environment. Automatically set by the rad CLI.') -param application string - -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - } -} - -resource backend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'backend' - properties: { - application: application - container: { - image: 'nginx:latest' - ports: { - web: { - containerPort: 80 - } - } - } - } -} 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 deleted file mode 100644 index eaef68374..000000000 --- a/docs/content/guides/author-apps/networking/howto-service-networking/snippets/2-app.bicep +++ /dev/null @@ -1,41 +0,0 @@ -extension radius - -@description('The application ID of the Radius environment. Automatically set by the rad CLI.') -param application string - -//FRONTEND -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - connections: { - backend: { - source: 'http://backend:80' - } - } - } -} -//FRONTEND - -resource backend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'backend' - properties: { - application: application - container: { - image: 'nginx:latest' - ports: { - web: { - containerPort: 80 - } - } - } - } -} diff --git a/docs/content/guides/author-apps/networking/howto-tls/https-app.png b/docs/content/guides/author-apps/networking/howto-tls/https-app.png deleted file mode 100644 index 57876b64c..000000000 Binary files a/docs/content/guides/author-apps/networking/howto-tls/https-app.png and /dev/null differ diff --git a/docs/content/guides/author-apps/networking/howto-tls/index.md b/docs/content/guides/author-apps/networking/howto-tls/index.md deleted file mode 100644 index d03221824..000000000 --- a/docs/content/guides/author-apps/networking/howto-tls/index.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -type: docs -title: "How To: Add TLS termination to a gateway" -linkTitle: "HTTPS/TLS" -description: "Learn how to deploy HTTPS-enabled application with a TLS certificate" -weight: 400 -slug: 'tls' -categories: "How-To" ---- - -This guide will show you how to add TLS and HTTPS to an application with a gateway. - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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. - - If running Radius on an Elastic Kubernetes Service (EKS) cluster you can optionally leverage an [Application Load Balancer](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html) for a hosted DNS name and record. - -## Step 1: Define a container - -Begin by creating a file named `app.bicep`. Add a container which will be exposed to the internet: - -{{< rad file="snippets/app-existing.bicep" marker="//FRONTEND" embed=true >}} - -## Step 2: Add a secret store - -TLS certificates need to be referenced via a Radius [secret store]({{< ref "/guides/author-apps/secrets" >}}). You can either reference an existing secret, or define a new one with certificate data. - -{{< tabs "Reference existing secrets" "Define new secrets" >}} - -{{< codetab >}} - -{{< alert title="Managing certificates in Kubernetes" color="info" >}} -[cert-manager](https://cert-manager.io/docs/) is a great way to manage certificates in Kubernetes and make them available as a Kubernetes secret. This example uses a Kubernetes secret that was setup by cert-manager -{{< /alert >}} - -{{< rad file="snippets/app-existing.bicep" marker="//SECRETS" embed=true >}} - -{{< /codetab >}} - -{{% codetab %}} - -{{< rad file="snippets/app-new.bicep" marker="//SECRETS" embed=true >}} - -{{% /codetab %}} - -{{< /tabs >}} - -## Step 3: Add a gateway - -Now that your certificate data is ready add a gateway and reference the secret store: - -{{< rad file="snippets/app-new.bicep" marker="//GATEWAY" embed=true >}} - -## Step 4: Deploy the application - -{{< tabs "Reference existing secrets" "Define new secrets" >}} - -{{% codetab %}} - -```sh -rad deploy app.bicep -a tlsdemo -``` - -{{% /codetab %}} - -{{% codetab %}} - -```sh -rad deploy app.bicep -a tlsdemo -p tlscrt=<base64-encoded TLS certificate> -p tlskey=<base64-encoded TLS certificate private key> -``` - -{{% /codetab %}} - -{{< /tabs >}} - -You should see the application deploy successfully, with the public endpoint printed automatically: - -``` -Building app.bicep... - Deploying template './app.bicep' for application 'tlsdemo' and environment 'default' from workspace 'default'... - - Deployment In Progress... - - Completed gateway Applications.Core/gateways - Completed frontend Applications.Core/containers - Completed secretstore Applications.Core/secretstores - - Deployment Complete - - Resources: - gateway Applications.Core/gateways - secretstore Applications.Core/secretstores - frontend Applications.Core/containers - - Public endpoint https://MYDOMAIN/ -``` - -## Step 5: Access HTTPS endpoint - -Once the deployment is complete you should see a public endpoint displayed at the end. Navigating to this public endpoint should show you your application that is accessed via HTTPS, assuming that you have a valid TLS certificate: - -{{< image src="https-app.png" alt="View TLS certificate" width="400px" >}} - -## Done - -You've successfully deployed an application with TLS termination. Make sure to cleanup your resources: - -```bash -rad app delete tlsdemo -y -``` - -## Further reading - -- [Networking overview]({{< ref "/guides/author-apps/networking/overview" >}}) -- [Gateway reference]({{< ref "/reference/resource-schema/core-schema/gateway" >}}) 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 deleted file mode 100644 index aec3ebe1e..000000000 --- a/docs/content/guides/author-apps/networking/howto-tls/snippets/app-existing.bicep +++ /dev/null @@ -1,62 +0,0 @@ -//FRONTEND -extension radius - -@description('The application ID being deployed. Injected automtically by the rad CLI') -param application string - -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - } -} -//FRONTEND - -//SECRETS -resource secretstore 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'secretstore' - properties: { - application: application - type: 'certificate' - // Reference the existing tls-certificate Kubernetes secret in the default namespace - // Change this if your Kubernetes secret is in a different namespace or is named differently - resource: 'default/tls-certificate' - data: { - // Make the tls.crt and tls.key secrets available to the application - // Change these if your secrets are named differently - 'tls.crt': {} - 'tls.key': {} - } - } -} -//SECRETS - -//GATEWAY -resource gateway 'Applications.Core/gateways@2023-10-01-preview' = { - name: 'gateway' - properties: { - application: application - hostname: { - fullyQualifiedHostname: 'YOUR_DOMAIN' // Replace with your domain name. - } - tls: { - certificateFrom: secretstore.id - minimumProtocolVersion: '1.2' - } - routes: [ - { - path: '/' - destination: 'http://${frontend.name}:3000' - } - ] - } -} -//GATEWAY 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 deleted file mode 100644 index 2cf807f1f..000000000 --- a/docs/content/guides/author-apps/networking/howto-tls/snippets/app-new.bicep +++ /dev/null @@ -1,71 +0,0 @@ -//FRONTEND -extension radius - -@description('The application ID being deployed. Injected automtically by the rad CLI') -param application string - -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - } -} -//FRONTEND - -//SECRETS -@description('TLS certificate data') -@secure() -param tlscrt string - -@description('TLS certificate key') -@secure() -param tlskey string - -resource secretstore 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'secretstore' - properties: { - application: application - type: 'certificate' - data: { - 'tls.crt': { - encoding: 'base64' - value: tlscrt - } - 'tls.key': { - encoding: 'base64' - value: tlskey - } - } - } -} -//SECRETS - -//GATEWAY -resource gateway 'Applications.Core/gateways@2023-10-01-preview' = { - name: 'gateway' - properties: { - application: application - hostname: { - fullyQualifiedHostname: 'YOUR_DOMAIN' // Replace with your domain name. - } - tls: { - certificateFrom: secretstore.id - minimumProtocolVersion: '1.2' - } - routes: [ - { - path: '/' - destination: 'http://${frontend.name}:3000' - } - ] - } -} -//GATEWAY diff --git a/docs/content/guides/author-apps/networking/overview/index.md b/docs/content/guides/author-apps/networking/overview/index.md deleted file mode 100644 index afa687476..000000000 --- a/docs/content/guides/author-apps/networking/overview/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -type: docs -title: "Overview: Application networking" -linkTitle: "Overview" -description: "Learn how to add networking to your Radius Application" -weight: 100 -categories: "Overview" ---- - -Radius networking resources allow you to model: - -- Communication between services -- Communication between a user and a service - -{{< image src="networking.png" alt="Diagram of a gateway with traffic going to a frontend container, which in turn sends traffic to the basket and catalog containers" width="400px" >}} - -## Service to service communication - -Radius containers can define connections to other containers, just like they can define connections to dependencies. - -Network connections are defined as strings containing: - -- The **scheme** (protocol) of the connection _(http, https, tcp, etc.)_ -- The **target** container/service to connect to _(basket, catalog, etc.)_ -- The **port** to connect to _(80, 443, etc.)_ - -For example, a frontend container may need to connect to a basket container. The frontend container would define a connection to the basket container, with the scheme `http`, the target `basket`, and the port `3000`. The connection would look like this: `http://basket:3000`. - -{{< image src="network-connection.png" alt="Diagram showing the components of a network connection" width="400px" >}} - -For more information on how to do service to service networking, visit the [service networking how-to guide]({{< ref howto-service-networking >}}): - -{{< button text="How-To: Service to service networking" page="howto-service-networking" >}} - -## Gateways - -A `gateway` defines how requests are routed to different resources, and also provides the ability to expose traffic to the internet. Conceptually, gateways allow you to have a single point of entry for traffic in your application, whether it be internal or external. - -Refer to the [Gateway schema]({{< ref gateway >}}) for more information on how to model gateways. - -### TLS Termination - -Gateways support TLS termination. This allows incoming encrypted traffic to be decrypted with a user-specific certificate and then routed, unencrypted, to the specified routes. TLS certificates can be stored or referenced via a [Radius secret store]({{< ref secretstore >}}). - -### SSL Passthrough - -A gateway can be configured to passthrough encrypted SSL traffic to an HTTP route and container. This is useful for applications that already have SSL termination configured, and do not want to terminate SSL at the gateway. - -To set up SSL passthrough, set `tls.sslPassthrough` to `true` on the gateway, and set a single route with no `path` defined (just `destination`). diff --git a/docs/content/guides/author-apps/networking/overview/network-connection.png b/docs/content/guides/author-apps/networking/overview/network-connection.png deleted file mode 100644 index 7575f6cfc..000000000 Binary files a/docs/content/guides/author-apps/networking/overview/network-connection.png and /dev/null differ diff --git a/docs/content/guides/author-apps/networking/overview/networking.png b/docs/content/guides/author-apps/networking/overview/networking.png deleted file mode 100644 index b458d4fe5..000000000 Binary files a/docs/content/guides/author-apps/networking/overview/networking.png and /dev/null differ diff --git a/docs/content/guides/author-apps/portable-resources/_index.md b/docs/content/guides/author-apps/portable-resources/_index.md deleted file mode 100644 index 0b08da29a..000000000 --- a/docs/content/guides/author-apps/portable-resources/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -type: docs -title: "Radius portable resources" -linkTitle: "Portable Resources" -description: "Learn how to make your applications portable" -weight: 400 -tags: ["portability"] ---- diff --git a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/demo-with-redis-screenshot.png b/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/demo-with-redis-screenshot.png deleted file mode 100644 index 9aa700ed3..000000000 Binary files a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/demo-with-redis-screenshot.png and /dev/null differ 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 deleted file mode 100644 index 9d948d136..000000000 --- a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -type: docs -title: "How-To: Author portable resources" -linkTitle: "Author portable resources" -description: "Learn how to author portable resources in Radius" -weight: 200 -categories: "How-To" -tags: ["portability"] ---- - -This guide will teach you how to author a portable resource for your [Radius Application]({{< ref "concepts/applications" >}}). - -## Prerequisites - -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 environment]({{< ref "installation#step-3-initialize-radius" >}}) -- [Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - -## Step 1: Add a portable resource - -Portable resources provide **abstraction** and **portability** to Radius Applications. Radius currently offers options to manually provision the resources or automatically provision them via Recipes: - -{{< tabs Recipe Manual >}} - -{{% codetab %}} - -Recipes handle infrastructure provisioning for you. You can use a Recipe to provision a Redis cache, using your environment's default Recipe. - -Create a file named `app.bicep` and paste the following: - -{{< rad file="snippets/app-redis-recipe.bicep" embed=true marker="//RECIPE" >}} - -To learn more about Recipes visit the [Recipes overview page]({{< ref "concepts/recipes" >}}). - -{{% /codetab %}} - -{{% codetab %}} - -You can also manually manage your infrastructure and use a portable resource to abstract the details. Create a file named `app.bicep` and paste the following: - -{{< rad file="snippets/app-redis-manual.bicep" embed=true marker="//MANUAL" >}} - -{{% /codetab %}} - -{{< /tabs >}} - -## Step 2: Add a container - -In your Bicep file `app.bicep`, add a container resource that will connect to the Redis cache. Note the connection to the Redis cache automatically injects connection-related environment variables into the container. Optionally, you can also manually access properties and set environment variables based on your portable resource values. - -{{< rad file="snippets/app-redis-manual.bicep" embed=true marker="//CONTAINER" >}} - -## Step 3: Deploy the app - -1. Run your application in your environment: - - ```bash - rad run ./app.bicep -a demo - ``` - -1. Visit [localhost:3000](http://localhost:3000) in your browser. You should see the following page, now showing injected environment variables: - - {{< image src="demo-with-redis-screenshot.png" alt="Screenshot of the demo app with all environment variables" width=1000px >}} - -## Cleanup - -Run `rad app delete` to cleanup your Radius application, container, and Redis cache: - -```bash -rad app delete -a demo -``` - -## Further reading - -- [Portable resource overview]({{< ref "/guides/author-apps/portable-resources/overview" >}}) -- [Radius Application overview]({{< ref "concepts/applications" >}}) 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 deleted file mode 100644 index 58c768fd0..000000000 --- a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-manual.bicep +++ /dev/null @@ -1,53 +0,0 @@ -//MANUAL -extension radius - -@description('Specifies the environment for resources.') -param environment string - -@description('Specifies the application for resources.') -param application string - -resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview' = { - name: 'myredis' - properties: { - environment: environment - application: application - resourceProvisioning: 'manual' - username: 'myusername' - host: 'mycache.contoso.com' - port: 8080 - secrets: { - password: '******' - } - } -} -//MANUAL - -//CONTAINER -resource container 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - env: { - // Manually access Redis connection information - REDIS_CONNECTION: { - value: redis.listSecrets().connectionString - } - } - ports: { - web: { - containerPort: 3000 - } - } - } - connections: { - // Automatically inject connection details - redis: { - source: redis.id - } - } - } -} -//CONTAINER 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 deleted file mode 100644 index aa6a8237b..000000000 --- a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-recipe.bicep +++ /dev/null @@ -1,17 +0,0 @@ -//RECIPE -extension radius - -@description('Specifies the environment for resources.') -param environment string - -@description('Specifies the application for resources.') -param application string - -resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview'= { - name: 'myredis' - properties: { - environment: environment - application: application - } -} -//RECIPE diff --git a/docs/content/guides/author-apps/portable-resources/overview/index.md b/docs/content/guides/author-apps/portable-resources/overview/index.md deleted file mode 100644 index 7e9944bfa..000000000 --- a/docs/content/guides/author-apps/portable-resources/overview/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -type: docs -title: "Overview: Portable Resources" -linkTitle: "Overview" -description: "Add portable resources to your Radius Application for infrastructure portability" -weight: 100 -categories: "Overview" -tags: ["portability"] ---- - -## Overview - -Portable resources provide **abstraction** and **portability** to Radius Applications. This allows development teams to depend on high level resource types and APIs, and let infra teams swap out the underlying resource and configuration. - -{{< image src="portable-resources.png" alt="Diagram of portable resources connecting to Azure CosmosDB, AWS MongoDB, and a MongoDB Docker container" width=700px >}} - -## Available resources - -The following portable resources are available to use within your application: - -- [`Applications.Core/extenders`]({{< ref api-extenders >}}) -- [`Applications.Datastores/mongoDatabases`]({{< ref api-mongodatabases >}}) -- [`Applications.Datastores/redisCaches`]({{< ref api-rediscaches >}}) -- [`Applications.Datastores/sqlDatabases`]({{< ref api-sqldatabases >}}) -- [`Applications.Dapr/pubSubBrokers`]({{< ref api-pubsubbrokers >}}) -- [`Applications.Dapr/secretStores`]({{< ref "/reference/api/applications.dapr/api-secretstores" >}}) -- [`Applications.Dapr/stateStores`]({{< ref api-statestores >}}) -- [`Applications.Messaging/rabbitmqQueues`]({{< ref api-rabbitmqqueues >}}) diff --git a/docs/content/guides/author-apps/portable-resources/overview/portable-resources.png b/docs/content/guides/author-apps/portable-resources/overview/portable-resources.png deleted file mode 100644 index 300f27aac..000000000 Binary files a/docs/content/guides/author-apps/portable-resources/overview/portable-resources.png and /dev/null differ diff --git a/docs/content/guides/author-apps/secrets/_index.md b/docs/content/guides/author-apps/secrets/_index.md deleted file mode 100644 index defcb445d..000000000 --- a/docs/content/guides/author-apps/secrets/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Secrets management" -linkTitle: "Secrets" -description: "Learn how to create and reference secrets in your Radius Application" -weight: 500 ---- 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 deleted file mode 100644 index c9499ce58..000000000 --- a/docs/content/guides/author-apps/secrets/howto-new-secretstore/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -type: docs -title: "How To: Create new Secret Store" -linkTitle: "New Secret Store" -description: "Learn how to create new secrets in your Radius Application" -weight: 200 -categories: "How-To" -tags: ["secrets"] ---- - -Radius secret stores securely manage secrets for your Environment and Application. - -By default, Radius leverages the hosting platform's secrets management solution to create and store the secret. For example, if you are deploying to Kubernetes, the secret store will be created as a Kubernetes Secret. - -## Pre-requisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- [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 - -Open the `app.bicep` from the current working directory and add a new Secret Store resource - -{{< rad file="snippets/secretstore.bicep" embed=true marker="//SECRET_STORE_NEW" >}} - -In this example a new secret store resource is created for storing a TLS certificate in it. - -## Step 2: Deploy the application - -Deploy the application with [`rad deploy`]({{< ref "rad_deploy" >}}): - -```bash -rad deploy app.bicep -a secretdemo -``` - -## Step 3: Verify the secrets are deployed - -Use the below command to verify if the secret got deployed: - -```bash -kubectl get secret -n default-secretdemo -``` - -You will find `appCert` of type kubernetes.io/tls automatically created. - -## Further reading - -- [Secret store schema]({{< ref secretstore >}}) -- [How To: gateway TLS termination]({{< ref howto-tls >}}) 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 deleted file mode 100644 index 1487310a3..000000000 --- a/docs/content/guides/author-apps/secrets/howto-new-secretstore/snippets/secretstore.bicep +++ /dev/null @@ -1,30 +0,0 @@ -extension radius - -@description('The app ID of your Radius Application. Set automatically by the rad CLI.') -param application string - -//SECRET_STORE_NEW -@description('The data for your TLS certificate') -@secure() -param tlscrt string - -@description('The key for your TLS certificate') -@secure() -param tlskey string - -resource appCert 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'appcert' - properties:{ - application: application - type: 'certificate' - data: { - 'tls.key': { - value: tlskey - } - 'tls.crt': { - value: tlscrt - } - } - } -} -//SECRET_STORE_NEW diff --git a/docs/content/guides/author-apps/secrets/overview/index.md b/docs/content/guides/author-apps/secrets/overview/index.md deleted file mode 100644 index 8a4e1f9fa..000000000 --- a/docs/content/guides/author-apps/secrets/overview/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -type: docs -title: "Overview: Secrets management" -linkTitle: "Overview" -description: "Learn how to create and reference secrets in your Radius Application" -weight: 100 -categories: "Overview" -tags: ["secrets"] ---- - -## Overview - -Sensitive data, such as TLS certificates, tokens, passwords, and keys that serve as digital authentication credentials are commonly referred to as secrets. A Radius Secret Store enables you to either store these secrets or reference existing secrets stored in external secret management solutions. Kubernetes Secrets is currently supported with others, such as Azure Keyvault or AWS Secrets Manager, coming in the future. - -An independent resource with its own lifecycle, a Radius Secret Store ensures that data is persisted across container restarts or mounts and can interact directly with the Radius Application Model. For instance, an Applications.Core/gateways resource can use this resource to store a TLS certificate and reference it. - -## Create a new Secret Store - -Radius leverages the secrets management solution available on the hosting platform to create and store the secret. For example, if you are deploying to Kubernetes, the secret will be created in Kubernetes Secrets. -Follow the [how-to guide on creating new secret store]({{< ref "/guides/author-apps/secrets/howto-new-secretstore" >}}) to learn more about creating a new secret store resource and storing a TLS certificate in it. - -## Reference an existing Secret Store - -You can also reference an existing secrets management solution that is external to the Radius Application stack. Note that only references to Kubernetes Secrets is currently supported, with more to come in the future. - -## Using Secret Stores - -Secret Stores can currently be used for TLS certificates with [Radius Gateways]({{< ref "guides/author-apps/networking/overview#gateways" >}}). - -Additional use-cases will be added in upcoming releases. - -## Further reading - -- [How To: gateway TLS termination]({{< ref howto-tls >}}) diff --git a/docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep b/docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep deleted file mode 100644 index 933c7c77f..000000000 --- a/docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep +++ /dev/null @@ -1,53 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Injected automatically by the rad CLI.') -param environment string - -@description('The data for your TLS certificate') -@secure() -param tlscrt string - -@description('The key for your TLS certificate') -@secure() -param tlskey string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'corerp-resources-secretstore' - properties: { - environment: environment - } -} - -//SECRET_STORE_NEW -resource appCert 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'appcert' - properties:{ - application: app.id - type: 'certificate' - data: { - 'tls.key': { - value: tlskey - } - 'tls.crt': { - value: tlscrt - } - } - } -} -//SECRET_STORE_NEW - -//SECRET_STORE_REF -resource existingAppCert 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'existing-appcert' - properties:{ - application: app.id - resource: 'secret-app-existing-secret' // Reference to the name of an external Kubernetes secret store - type: 'certificate' // The type of secret in your resource - data: { - // The keys in this object are the names of the secrets in an external secret store - 'tls.crt': {} - 'tls.key': {} - } - } -} -//SECRET_STORE_REF diff --git a/docs/content/guides/deploy-apps/_index.md b/docs/content/guides/deploy-apps/_index.md deleted file mode 100644 index 644ee0238..000000000 --- a/docs/content/guides/deploy-apps/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Deploying applications" -linkTitle: "Deploying applications" -description: "Learn how to deploy a Radius Application to an environment" -weight: 200 ---- \ No newline at end of file diff --git a/docs/content/guides/deploy-apps/environments/_index.md b/docs/content/guides/deploy-apps/environments/_index.md deleted file mode 100644 index c345ea6b3..000000000 --- a/docs/content/guides/deploy-apps/environments/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: docs -title: "Radius Environments" -linkTitle: "Environments" -description: "Learn about Radius Environments" -weight: 200 -tags: ["environments"] ---- - diff --git a/docs/content/guides/deploy-apps/environments/howto-environment/index.md b/docs/content/guides/deploy-apps/environments/howto-environment/index.md deleted file mode 100644 index 45b174a64..000000000 --- a/docs/content/guides/deploy-apps/environments/howto-environment/index.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -type: docs -title: "How-To: Initialize Radius Environments" -linkTitle: "Initialize Environments" -description: "Learn how to create Radius Environments" -weight: 200 -categories: "How-To" -tags: ["environments"] ---- - -Radius Environments are prepared landing zones for applications that contain configuration and Recipes. To learn more visit the [environments overview]({{< ref "concepts/environments" >}}) page. - -Radius Environments can be setup with the rad CLI via two paths: interactive or manual. - -## Pre-requisites - -- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - -## Create a development environment - -1. Initialize a new [Radius Environment]({{< ref "concepts/environments">}}) with [`rad init`]({{< ref rad_initialize >}}): - ```bash - rad init - ``` - - 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... - - πŸ•” Install Radius {{< param version >}} - - Kubernetes cluster: kind - - Kubernetes namespace: radius-system - ⏳ Create new environment default - - Kubernetes namespace: default - - Recipe pack: local-dev - ⏳ Scaffold application - ⏳ Update local configuration - ``` - -1. Verify the initialization by running: - ```bash - kubectl get deployments -n radius-system - ``` - - You should see: - - ``` - NAME READY UP-TO-DATE AVAILABLE AGE - ucp 1/1 1 1 53s - appcore-rp 1/1 1 1 53s - bicep-de 1/1 1 1 53s - contour-contour 1/1 1 1 46s - ``` - - You can also use [`rad env list`]({{< ref rad_environment_list.md >}}) to view your environment: - - ```bash - rad env list - ``` -1. Use `rad recipe list` to see the list of available Recipes: - ```bash - rad recipe list - ``` - - ``` - NAME TYPE TEMPLATE KIND TEMPLATE - default Applications.Datastores/mongoDatabases bicep ghcr.io/radius-project/recipes/local-dev/mongodatabases:latest - default Applications.Datastores/redisCaches bicep ghcr.io/radius-project/recipes/local-dev/rediscaches:latest - ``` - - You can follow the [Recipes]({{< ref "concepts/recipes" >}}) documentation to learn more about the Recipes and how to use them in your application. - -## Create an environment interactively - -1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): - - ```bash - rad init --full - ``` - -1. Follow the prompts, specifying: - - **Namespace** - The Kubernetes namespace where your application containers and networking resources will be deployed (different than the Radius control-plane namespace, `radius-system`) - - **Azure provider** (optional) - Allows you to [deploy and manage Azure resources]({{< ref "/guides/operations/providers/azure-provider" >}}) - - **AWS provider** (optional) - Allows you to [deploy and manage AWS resources]({{< ref "/guides/operations/providers/aws-provider" >}}) - - **Environment name** - The name of the environment to create - - You should see the following output: - - ``` - Initializing Radius... - - βœ… Install Radius {{< param version >}} - - Kubernetes cluster: k3d-k3s-default - - Kubernetes namespace: radius-system - βœ… Create new environment default - - Kubernetes namespace: default - - Recipe pack: dev - βœ… Scaffold application samples - βœ… Update local configuration - - Initialization complete! Have a RAD time 😎 - ``` - -1. Verify the Radius services were installed by running: - - ```bash - kubectl get deployments -n radius-system - ``` - - You should see: - - ``` - NAME READY UP-TO-DATE AVAILABLE AGE - ucp 1/1 1 1 2m56s - appcore-rp 1/1 1 1 2m56s - bicep-de 1/1 1 1 2m56s - contour-contour 1/1 1 1 2m33s - ``` - -1. Verify an environment was created with [`rad env show`]({{< ref rad_environment_show.md >}}): - - ```bash - rad env show -o json - ``` - - You should see your new environment: - - ``` - { - "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" - } - ``` - -## Create an environment manually (advanced) - -Radius can also be installed and an environment created with manual rad CLI commands. This is useful for pipelines or scripts that need to install and manage Radius. - -1. Install Radius onto a Kubernetes cluster: - - Run [`rad install kubernetes`]({{< ref rad_install_kubernetes >}}) to install Radius into your default Kubernetes context and cluster: - - ```bash - rad install kubernetes - ``` - - You should see the following message: - - ``` - Installing Radius version 2134e8e to namespace: radius-system... - ``` - -1. Create a new Radius resource group: - - [Radius resource groups]({{< ref groups >}}) are used to organize Radius resources such as applications, environments, portable resources, and routes. Run [`rad group create`]({{< ref rad_group_create >}}) to create a new resource group: - - ```bash - rad group create myGroup - ``` - - You should see the following message: - - ``` - creating resource group "myGroup" in workspace ""... - - resource group "myGroup" created - ``` - - -1. Create your Radius Environment: - - Run [`rad env create`]({{< ref rad_environment_create >}}) to create a new environment in your resource group. Specify the `--namespace` flag to select the Kubernetes namespace to deploy resources into: - - ```bash - rad env create myEnvironment --group myGroup --namespace my-namespace - ``` - - You should see your Radius Environment being created and linked to your resource group: - - ``` - Creating Environment... - Successfully created environment "myEnvironment" in resource group "myGroup" - ``` - -1. Verify the initialization by running: - ```bash - kubectl get deployments -n radius-system - ``` - - You should see: - - ``` - NAME READY UP-TO-DATE AVAILABLE AGE - ucp 1/1 1 1 2m56s - appcore-rp 1/1 1 1 2m56s - bicep-de 1/1 1 1 2m56s - contour-contour 1/1 1 1 2m33s - ``` - - You can also use [`rad env list`]({{< ref rad_environment_list.md >}}) to see if the created environment gets listed: - - ```bash - rad env list --group myGroup - ``` - - You should see: - - ``` - NAME - myEnvironment - ``` - -## Next steps - -Follow the [cloud provider guides]({{< ref providers >}}) to configure cloud providers for your environment to deploy and manage cloud resources. \ No newline at end of file diff --git a/docs/content/guides/deploy-apps/gitops/_index.md b/docs/content/guides/deploy-apps/gitops/_index.md deleted file mode 100644 index efa876534..000000000 --- a/docs/content/guides/deploy-apps/gitops/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Radius + GitOps" -linkTitle: "GitOps" -description: "Learn about how Radius is integrated with GitOps" -weight: 500 ---- diff --git a/docs/content/guides/deploy-apps/gitops/howto-flux/index.md b/docs/content/guides/deploy-apps/gitops/howto-flux/index.md deleted file mode 100644 index e791fd110..000000000 --- a/docs/content/guides/deploy-apps/gitops/howto-flux/index.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -type: docs -title: "How-To: Set up Radius with Flux" -linkTitle: "Flux" -description: "Learn how to set up Radius to work with Flux for GitOps" -weight: 200 -categories: "How-To" -tags: ["gitops", "flux", "continuous", "delivery", "deployment"] ---- - -This guide will provide an overview of how to: - -1. Set up Radius with Flux for GitOps -1. Configure Flux to manage your Radius application -1. Deploy your Radius application using Flux - -## Prerequisites - -- [Supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview" >}}) -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) -- A remote Git repository (e.g., GitHub, GitLab, etc.) to store your application files -- [Flux CLI](https://fluxcd.io/docs/installation/) -- [Flux control plane components](https://fluxcd.io/flux/installation/#install-the-flux-controllers) installed in your Kubernetes cluster - {{< alert title="⚠️ Flux Network Policy" color="warning" >}} - When installing Flux using the `flux bootstrap` or `flux install` commands, ensure that the `--network-policy false` flag is specified, or that the network policy is configured to allow access from `radius-system` namespace to the source controller. This is important for the Flux source controller to be able to communicate with your Git repository and sync changes effectively. - For more information on the network policy, see the [Flux documentation](https://fluxcd.io/flux/installation/configuration/optional-components/#network-policies). - {{< /alert >}} - -## Step 1: Create a Git Repository - -1. Create a new directory for your application: - - ```bash - mkdir radius-flux-app - cd radius-flux-app - ``` - -1. Initialize a new Git repository and sync it with your remote repository: - - ```bash - git init - git add . - git remote add origin <your-repo-url> - ``` - -## Step 2: Prepare Application for Deployment by Flux - -1. Create a new Bicep file named `app.bicep` in the `radius-flux-app` directory. This file will define your application resources. Here is an example of a simple application that deploys a demo container: - - {{% rad file="snippets/2-app-with-environment.bicep" embed=true %}} - - Next, we will create a configuration file in our repository to inform Radius about which Bicep files to deploy. This file is named `radius-gitops-config.yaml` and it will be created in the same directory as your `app.bicep` file. - - Create a new file named `radius-gitops-config.yaml` and add the following content: - - {{% rad file="snippets/2-radius-gitops-config.yaml" embed=true %}} - - Finally, commit and push your changes to the Git repository: - - ```bash - git add app.bicep radius-gitops-config.yaml - git commit -m "Add Radius application and configuration for Flux" - git push origin main - ``` - -## Step 3: Configure Flux to Manage Your Application - -1. Register your Git repository with Flux: - - ```bash - flux create source git radius-flux-app \ - --url=<your-repo-url> \ - --branch=main - ``` - - Now, Flux will monitor your Git repository for changes and Radius will deploy the application automatically when changes are detected. - - {{< alert title="πŸ’‘ Flux Sync" color="info" >}} - You can manually trigger a sync in Flux by running the following command: - - ```bash - flux reconcile source git radius-flux-app - ``` - This will force Flux to check for changes in the Git repository and deploy any updates to your Kubernetes cluster. - {{< /alert >}} - - After some time, you should be able to see the resources in your Kubernetes cluster: - - ```bash - ❯ kubectl get pods -A - ... - NAMESPACE NAME READY STATUS RESTARTS AGE - default-app demo-56d7fd6b64-q95sl 1/1 Running 0 27s - ... - ``` - - You can also use [`rad app graph`]({{< ref rad_application_graph >}}) to visualize the resources created by your application: - - ```bash - ❯ rad app graph -a app - Displaying application: app - - Name: demo (Applications.Core/containers) - Connections: (none) - Resources: - demo (apps/Deployment) - demo (core/Service) - demo (core/ServiceAccount) - demo (rbac.authorization.k8s.io/Role) - demo (rbac.authorization.k8s.io/RoleBinding) - - ``` - - {{< alert title="πŸ’‘ Debugging Radius + GitOps" color="info" >}} - Behind the scenes, Radius will create a custom resource called `DeploymentTemplate` to represent your Bicep deployment. You can check the status of this resource to see if there are any issues with the deployment: - - ```bash - ❯ kubectl get deploymenttemplates -A - NAMESPACE NAME STATUS - app app.bicep Ready - ❯ kubectl describe deploymenttemplate app.bicep -n app - ... - ``` - {{< /alert >}} - -## Step 5: Update Your Application - -Now that your application is registered with Flux, you can make changes to your application definitions and push them to your Git repository. Flux and Radius will do the rest - automatically detecting the changes and deploying them to your Kubernetes cluster. - -1. Open `app.bicep` and make some changes to the application definition. For example, you can specify parameters and increase the number of replicas for the demo container: - - {{% rad file="snippets/3-app-add-replicas.bicep" embed=true %}} - -1. Add a new file `app.bicepparam` to define the parameters for your application: - - {{% rad file="snippets/3-app.bicepparam" embed=true %}} - -1. Update the `radius-gitops-config.yaml` file to include the new parameter file: - - {{% rad file="snippets/3-radius-gitops-config.yaml" embed=true %}} - -1. As before, commit and push your changes to the Git repository: - - ```bash - git add app.bicep app.bicepparam radius-gitops-config.yaml - git commit -m "Update application definition and parameters" - git push origin main - ``` - - After some time (Flux needs to reconcile the Git repository), you should be able to see that the application has been scaled up to 3 replicas: - - ```bash - ❯ kubectl get pods -A - NAMESPACE NAME READY STATUS RESTARTS AGE - ... - default-app demo-56d7fd6b64-6zwj7 1/1 Running 0 2m19s - default-app demo-56d7fd6b64-n9rqz 1/1 Running 0 2m19s - default-app demo-56d7fd6b64-q95sl 1/1 Running 0 13m - ... - ``` - -## Done - -Congratulations! You have successfully integrated Radius with Flux for GitOps. You can now manage your Radius applications using Git as the single source of truth. - -## Cleanup - -To cleanup the resources created in this guide, you can update the `radius-gitops-config.yaml` to remove the Bicep file entries in the `radius-gitops-config.yaml` file. - -Before: -```yaml -config: - - name: app.bicep - params: app.bicepparam - resourceGroup: default -``` - -After: -```yaml -config: - # intentionally empty - no Bicep files to deploy. -``` - -Then, commit the changes: -``` - -```bash -rm app.bicep -rm app.bicepparam -git add app.bicep app.bicepparam radius-gitops-config.yaml -git commit -m "Remove application files" -git push origin main -``` - -After some time, you should see that the resources have been removed from your Kubernetes cluster. diff --git a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/2-app-with-environment.bicep b/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/2-app-with-environment.bicep deleted file mode 100644 index 8620535aa..000000000 --- a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/2-app-with-environment.bicep +++ /dev/null @@ -1,31 +0,0 @@ -// Import the set of Radius resources (Applications.*) into Bicep -extension radius - -@description('The Radius environment name to deploy the application and resources to.') -param environment string = 'default' - -resource env 'Applications.Core/environments@2023-10-01-preview' existing = { - name: environment -} - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'app' - properties: { - environment: env.id - } -} - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - } -} diff --git a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/2-radius-gitops-config.yaml b/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/2-radius-gitops-config.yaml deleted file mode 100644 index 19a8b81da..000000000 --- a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/2-radius-gitops-config.yaml +++ /dev/null @@ -1,3 +0,0 @@ -config: - - name: app.bicep - resourceGroup: default diff --git a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-app-add-replicas.bicep b/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-app-add-replicas.bicep deleted file mode 100644 index 5365042ad..000000000 --- a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-app-add-replicas.bicep +++ /dev/null @@ -1,40 +0,0 @@ -// Import the set of Radius resources (Applications.*) into Bicep -extension radius - -@description('The Radius environment name to deploy the application and resources to.') -param environment string - -@description('The number of replicas to deploy for the demo container.') -param replicas string - -resource env 'Applications.Core/environments@2023-10-01-preview' existing = { - name: environment -} - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'app' - properties: { - environment: env.id - } -} - -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 - } - } - } - extensions: [ - { - kind: 'manualScaling' - replicas: int(replicas) - } - ] - } -} diff --git a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-app.bicepparam b/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-app.bicepparam deleted file mode 100644 index bfbed6870..000000000 --- a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-app.bicepparam +++ /dev/null @@ -1,4 +0,0 @@ -using 'app.bicep' - -param environment = 'default' -param replicas = '3' diff --git a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-radius-gitops-config.yaml b/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-radius-gitops-config.yaml deleted file mode 100644 index d81445f24..000000000 --- a/docs/content/guides/deploy-apps/gitops/howto-flux/snippets/3-radius-gitops-config.yaml +++ /dev/null @@ -1,4 +0,0 @@ -config: - - name: app.bicep - params: app.bicepparam - resourceGroup: default \ No newline at end of file diff --git a/docs/content/guides/deploy-apps/gitops/overview/index.md b/docs/content/guides/deploy-apps/gitops/overview/index.md deleted file mode 100644 index 5992fa3c0..000000000 --- a/docs/content/guides/deploy-apps/gitops/overview/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -type: docs -title: "Overview: Radius and GitOps" -linkTitle: "Overview" -description: "Learn about how to leverage GitOps tools to deploy Radius resources" -weight: 100 -categories: "Overview" -tags: ["gitops", "continuous", "delivery", "deployment"] ---- - -Radius integrates seamlessly with GitOps to enhance the continuous deployment and management of cloud-native applications and infrastructure. Currently, Radius has built-in support for [Flux](https://fluxcd.io/) and can be extended to support other platforms. - -## What is GitOps? - -GitOps is a popular set of practices, implemented as popular tools like [Flux](https://fluxcd.io/), that mitigates these challenges for enterprise application teams that use git for source control and Kubernetes for orchestration of software containers. The core concept of GitOps is to rely on a git repository that serves as a single source of truth: i.e. it contains current declarative descriptions of the required infrastructure for a given production environment. It also contains a description of the workflow required to prevent drift between the repo and the production environment. Using GitOps, developers and operators can manage applications in production without needing to write custom scripts or maintain complex CD pipelines. - -## GitOps capabilities in Radius - -1. **Declarative Configuration**: GitOps allows users to define their infrastructure and application configurations declaratively in Git repositories. This ensures that the desired state of the system is version-controlled and easily auditable. - -2. **Continuous Deployment**: With GitOps, any changes pushed to the Git repository automatically trigger deployment processes. Radius integrates with GitOps tools to facilitate continuous deployment, ensuring that the production environment always matches the state defined in the repository. - -3. **Drift Detection and Reconciliation**: The GitOps tool continuously monitors the production environment for any drift from the desired state defined in the Git repository. If any discrepancies are detected, Radius will be triggered to automatically reconcile the state to match the repository, maintaining consistency and reliability. - -4. **Enhanced Security and Compliance**: By using Git as the single source of truth, users can ensure that all changes are tracked and auditable, even if they are executed by Radius. This enhances security and compliance, as every change is documented and can be reviewed. - -5. **Scalability and Flexibility**: Radius's integration with GitOps tools supports scalable and flexible deployment strategies. Whether deploying to a single cluster or multiple clusters across different environments, Radius provides a consistent and reliable deployment process. - -## Getting Started - -Today, Radius has integrated first-class support for [Flux](https://fluxcd.io/), a popular GitOps tool. Flux is designed to work with Kubernetes and provides a powerful set of features for managing applications and infrastructure through Git. - -To get started with using Radius and Flux, check out the [how-to guide for Radius + Flux]({{< ref "guides/deploy-apps/gitops/howto-flux" >}}). diff --git a/docs/content/guides/deploy-apps/howto-delete/index.md b/docs/content/guides/deploy-apps/howto-delete/index.md deleted file mode 100644 index bb7eda08a..000000000 --- a/docs/content/guides/deploy-apps/howto-delete/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -type: docs -title: "How-To: Delete an application from a Radius Environment" -linkTitle: "Delete apps" -description: "Learn how to delete a Radius Application" -weight: 400 -categories: "How-To" -tags: ["delete"] ---- - -## Pre-requisites - -- A [deployed application]({{< ref deploy-apps >}}) in a Radius Environment. - -## Step 1: Delete the Radius Application from the environment - -You can delete the Radius Application using the [`rad app delete`]({{< ref rad_application_delete >}}) command: - -```bash -rad app delete <appname> -``` - -This will delete the following resources from the Radius Environment - -1. All the resources created by Radius on the Kubernetes cluster under the `<namespace-name>-<app-name>` namespace -1. All the resources provisioned by Recipes - -## Step 2: Delete any cloud/platform resources - -AWS, Azure, Kubernetes, and any other cloud/platform resources that were deployed alongside your Radius Application and not as part of a Recipe need to be deleted as a separate step. - -{{< tabs Azure AWS Kubernetes >}} - -{{% codetab %}} -Azure resources can be deleted via the [Azure portal](https://portal.azure.com/) or the [Azure CLI](https://learn.microsoft.com/cli/azure/resource?view=azure-cli-latest#az-resource-delete). -{{% /codetab %}} - -{{% codetab %}} - AWS resources can be deleted via the [AWS console](https://aws.amazon.com/console/) or the [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/delete-resource.html). -{{% /codetab %}} - -{{% codetab %}} -Kubernetes resources can be deleted via [kubectl delete](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#deleting-resources). -{{% /codetab %}} - -{{< /tabs >}} \ No newline at end of file diff --git a/docs/content/guides/deploy-apps/howto-deploy/_index.md b/docs/content/guides/deploy-apps/howto-deploy/_index.md deleted file mode 100644 index 91afa66c7..000000000 --- a/docs/content/guides/deploy-apps/howto-deploy/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Deploying applications" -linkTitle: "Deploy apps" -description: "Learn how to deploy a Radius Application to an environment" -weight: 300 ---- \ No newline at end of file diff --git a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/icon.png b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/icon.png deleted file mode 100644 index 267facc02..000000000 Binary files a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/icon.png and /dev/null differ 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 deleted file mode 100644 index a3f7c94f6..000000000 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/index.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -type: docs -title: "How-To: Deploy an application with Github Actions" -linkTitle: "Deploy via GitHub Actions" -description: "Learn about adding your Radius apps to your deployment pipelines with GitHub Actions" -weight: 300 -categories: "How-To" -tags: ["CI/CD"] ---- - -It's easy to get Radius added to your GitHub Actions deployment pipelines. By leveraging the `rad` CLI, you can keep your checked-in app definitions in sync with deployed instances of your app. - -## Prerequisites - -- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) -- Radius control plane [installed in your cluster]({{< ref kubernetes-install >}}) -- GitHub repo with Actions enabled - -## Step 1: Create your environment and application definitions - -Make sure you have the following files checked into your repository under `iac/`: - -### `env.bicep` - -{{< rad file="snippets/env.bicep" embed="true" >}} - -### `app.bicep` - -{{< rad file="snippets/app.bicep" embed="true" >}} - -### [`bicepconfig.json`]({{< ref "/guides/tooling/bicepconfig/overview" >}}) - -```json -{ - "experimentalFeaturesEnabled": { - "extensibility": true - }, - "extensions": { - "radius": "br:biceptypes.azurecr.io/radius:<release-version>", - "aws": "br:biceptypes.azurecr.io/aws:<release-version>" - } -} -``` - -## Step 2: Create your workflow file - -Create a new file named `deploy-radius.yml` under `.github/workflows/` and paste the following: - -```yml -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 -``` - -This workflow begins by checking out the repository. It then sets up the kubectl tool to access your cluster. - -## Step 3: Connect to your cluster - -To interact with the cluster, the rad CLI requires a valid kubectl context. Add the following steps to your workflow to connect to your cluster: - -{{< tabs AKS AWS >}} - -{{% codetab %}} -Ensure the service principal created above has the proper RBAC assignment to download the AKS context. Then append the following steps to your workflow: - -```yml - - name: az Login - uses: azure/login@v2 - with: - creds: ${{ secrets.AZURE_CREDENTIALS }} - - name: Configure kubectl context - run: az aks get-credentials --name ${CLUSTER} --resource-group ${RESOURCE_GROUP} --subscription ${SUBSCRIPTION_ID} -``` - -{{% /codetab %}} - -{{% codetab %}} - -```yml - - name: Configure AWS credentials - uses: aws-actions/configure-aws-credentials@v1 - with: - aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} - aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} - aws-region: us-east-2 - - name: Get EKS kubeconfig - run: aws eks update-kubeconfig --region us-east-2 --name my-cluster -``` - -{{% /codetab %}} - -{{< /tabs >}} - -## Step 4: Install the rad CLI and deploy environment - -Next, download the latest `rad` CLI release and setup your workspace: - -```yml - - 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 -``` - -> **Note**: Radius currently requires an environment be present in order to deploy an environment via Bicep. This will be fixed in an upcoming release. - -## Step 5: Deploy application - -Finally, run the [`rad deploy`]({{< ref rad_deploy >}}) command to deploy your application. Specify the path to your application Bicep. If the application had been previously deployed, it will be updated. - -```yml - - name: Deploy app - run: ./rad deploy ./iac/app.bicep -``` - -## Step 4: Commit and run your workflow - -Commit and push your workflow to your repository. This will trigger your workflow to run, and your application to deploy: - -```bash -git commit .github/workflows/deploy-radius.yml -m "Add Radius deploy workflow" -git push -``` - -Done! 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 deleted file mode 100644 index f470df55e..000000000 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/app.bicep +++ /dev/null @@ -1,12 +0,0 @@ -extension radius - -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -// Put your other resources here 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 deleted file mode 100644 index bdd8cea61..000000000 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/env.bicep +++ /dev/null @@ -1,11 +0,0 @@ -extension radius - -resource environment 'Applications.Core/environments@2023-10-01-preview' = { - name: 'myenv' - properties: { - compute: { - kind: 'kubernetes' - namespace: 'default' - } - } -} diff --git a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-rad-cli/index.md b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-rad-cli/index.md deleted file mode 100644 index 3d6d33397..000000000 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-rad-cli/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -type: docs -title: "How-To: Deploying applications into a Radius Environment" -linkTitle: "Deploy via CLI" -description: "Learn how to deploy a Radius Application" -weight: 200 -categories: "How-To" -tags: ["deployments"] ---- - -## Pre-requisites - -- [An authored Radius Application]({{< ref author-apps >}}) - -## Step 1 : Deploy an application into a Radius Environment - -{{< tabs Deploy-app Deploy-app-with-parameters >}} - -{{% codetab %}} -An application can be deployed to an environment with [`rad deploy`]({{< ref rad_deploy>}}): - -```bash - rad deploy app.bicep - ``` - - This will deploy the application to the created Radius Environment. - {{% /codetab %}} - - {{% codetab %}} -Parameters can be included as part of `rad deploy` via the `-p/--parameters` flag: - -```bash - rad deploy app.bicep -p param1=value1 -p param2=value2 - ``` - - This will deploy the application to the created Radius Environment injecting the parameters into the application. - - You can find more examples of deploying applications with parameters [here]({{< ref "rad_deploy#examples" >}}). - {{% /codetab %}} - - {{< /tabs >}} - - > Follow the [how-to guide]({{< ref howto-troubleshootapps >}}) for guidance on troubleshooting your Radius Application diff --git a/docs/content/guides/deploy-apps/howto-deploy/howto-run-app/index.md b/docs/content/guides/deploy-apps/howto-deploy/howto-run-app/index.md deleted file mode 100644 index b9f168d21..000000000 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-run-app/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -type: docs -title: "How-To: Run applications on Radius" -linkTitle: "Run apps" -description: "Learn how to run applications on Radius" -weight: 100 -categories: "How-To" -tags: ["deployments"] ---- - -## Pre-requisites - -- [An authored Radius Application]({{< ref author-apps >}}) - -## Step 1: Run an application - -{{< tabs Run-app Run-app-with-parameters >}} - -{{% codetab %}} -You can run an application using the [`rad run`]({{< ref rad_run >}}) command. - -```bash - rad run app.bicep - ``` - -This will deploy the application to your environment, create port-forwards for all container ports, and stream container logs to the console. -{{% /codetab %}} - -{{% codetab %}} -Parameters can be included as part of `rad run` via the `-p/--parameters` flag: - -```bash - rad run app.bicep -p param1=value1 -p param2=value2 -``` - -This will deploy the application to the created Radius Environment injecting the parameters into the application. - -You can find more examples of deploying applications with parameters [here]({{< ref "rad_run#examples" >}}). -{{% /codetab %}} - - {{< /tabs >}} - - > Follow the [how-to guide]({{< ref howto-troubleshootapps >}}) for guidance on troubleshooting your apps. diff --git a/docs/content/guides/deploy-apps/howto-troubleshootapps/index.md b/docs/content/guides/deploy-apps/howto-troubleshootapps/index.md deleted file mode 100644 index 494b9569a..000000000 --- a/docs/content/guides/deploy-apps/howto-troubleshootapps/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -type: docs -title: "How-To: Troubleshoot applications" -linkTitle: "Troubleshoot apps" -description: "Learn how to troubleshoot issues with the Radius Application" -weight: 900 -categories: "How-To" -tags: ["troubleshooting"] ---- - -## Pre-requisites - -- A [deployed application]({{< ref deploy-apps >}}) in a Radius Environment. - -## Step 1: Port-forward container to your local machine - -Use the below command to port-forward the container to your local machine. This enables you to access the container from your local machine. - -```bash -rad resource expose Applications.Core/containers <container_name> -a <app_name> --port <port_number> -``` - -Refer to [`rad resource expose`]({{< ref rad_resource_expose >}}) for more details on the command. - -## Step 2: Inspect container logs - -If your Radius Application is unresponsive or does not connect to its dependencies, Use the below command to inspect logs from container: - -```bash -rad resource logs Applications.Core/containers <container_name> -a <app_name> -``` - -> Also refer to the [connections section]({{< ref "guides/author-apps/containers/overview#connections" >}}) to know about the naming convention of the environment variables and inspect if your application uses the right variables. - -## Step 3: Inspect control-plane logs - -If you hit errors while deploying the application, look at the control plane logs to see if there are any errors. You can use the following command to view the logs: - -```bash -rad debug-logs -``` - -Inspect the UCP and DE logs to see if there are any errors. - ->Also make sure to [open an Issue](https://github.com/radius-project/radius/issues/new/choose) if you encounter a generic `Internal server error` message or an error message that is not self-serviceable, so we can address the root error not being forwarded to the user. diff --git a/docs/content/guides/operations/_index.md b/docs/content/guides/operations/_index.md deleted file mode 100644 index 8356acae6..000000000 --- a/docs/content/guides/operations/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Environment operations guides" -linkTitle: "Operations" -description: "Learn how to deploy and operate Radius Environments" -weight: 400 ---- diff --git a/docs/content/guides/operations/control-plane/_index.md b/docs/content/guides/operations/control-plane/_index.md deleted file mode 100644 index f3a27855f..000000000 --- a/docs/content/guides/operations/control-plane/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -type: docs -title: "Control plane" -linkTitle: "Control plane" -description: "Configure and manage your Radius control plane" -weight: 200 -tags: ["control plane"] ---- diff --git a/docs/content/guides/operations/control-plane/howto-postman/index.md b/docs/content/guides/operations/control-plane/howto-postman/index.md deleted file mode 100644 index 1091762fe..000000000 --- a/docs/content/guides/operations/control-plane/howto-postman/index.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -type: docs -title: "How-To: Interact with the Radius API in Postman" -linkTitle: "How-To: Interact with Radius API" -weight: 500 -description: "How-To: Interact directly with the Radius API using Postman" -categories: ["How-To"] -tags: ["Radius API"] ---- - -This guide will show you how to use [Postman](https://postman.com) to interact with the Radius API. Postman is a popular tool for interacting with REST APIs, and it can be used to explore the Radius API without writing any code. - -### Prerequisites - -Before you get started, you'll need to make sure you have the following tools and resources: - -- [Postman](https://www.postman.com/) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) - -### Step 1: Create Kubernetes objects - -Radius uses the [Kubernetes API aggregation layer](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/) to expose its API, so while Radius is not a Kubernetes operator itself, it leverages the Kubernetes platform to expose its own API. - -To access the Radius API, begin by creating the necessary Kubernetes objects. - -1. Create a new file named `postman.yaml` and add the following contents: - - ```yaml - apiVersion: v1 - kind: ServiceAccount - metadata: - name: postman-account - namespace: radius-system - --- - apiVersion: rbac.authorization.k8s.io/v1 - kind: ClusterRole - metadata: - name: postman-role - namespace: radius-system - rules: - - apiGroups: ["", "api.ucp.dev"] - resources: ["*"] - verbs: ["*"] - --- - apiVersion: rbac.authorization.k8s.io/v1 - kind: ClusterRoleBinding - metadata: - name: postman-role-binding - namespace: radius-system - subjects: - - kind: ServiceAccount - name: postman-account - namespace: radius-system - roleRef: - kind: ClusterRole - name: postman-role - apiGroup: rbac.authorization.k8s.io - ``` - -1. Save the file and then apply it using the following command: - - ```bash - kubectl apply -f postman.yaml - ``` - - This will create a `ServiceAccount` named `postman-account`, a `ClusterRole` named `postman-role` with full access to all `api.ucp.dev` resources, and a `ClusterRoleBinding` named `postman-role-binding` that binds the `postman-account` to the `postman-role`. - -### Step 2: Generate a token - -Now that you have created the necessary Kubernetes objects, you can generate a token that can be used to authenticate to the Kubernetes API. - -1. Run the following command to generate a token for the `postman-account` service account: - - ```bash - kubectl create token postman-account -n radius-system - ``` - - This will create a token with the default expiration time of 1 hour. If you want to set a different expiration time, you can use the `--duration` flag to specify a duration in seconds (up to 48 hours). - -### Step 3: Use Postman - -Next, you'll need to get the control plane API endpoint and use Postman to interact with the Radius API. - -1. Begin by getting your cluster endpoint: - - ```bash - kubectl cluster-info - ``` - - This will output information about your Kubernetes cluster, including the control plane API endpoint: - - ``` - Kubernetes control plane is running at https://kubernetes.docker.internal:6443 - CoreDNS is running at https://kubernetes.docker.internal:6443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy - ``` - -1. Open Postman and create a new request -1. Set the method to `GET` -1. Set the URL to the following, which will [retrieve all your resource groups]({{< ref api-ucp >}}): - - ``` - <your-cluster-control-plane>/apis/api.ucp.dev/v1alpha3/planes/radius/local/resourcegroups?api-version=2023-10-01-preview - ``` - - {{< image src="postman-url.png" width=900px alt="Screenshot of Postman with filled out URL" >}} - -1. Open the `Authorization` tab and select `Bearer Token` from the `Type` dropdown. Paste the token you generated in step 2 into the `Token` field: - - {{< image src="postman-auth.png" width=900px alt="Screenshot of Postman with filled out auth token" >}} - -1. Click the `Send` button to send the request. You will now see your resource groups: - - ``` - { - "value": [ - { - "id": "/planes/radius/local/resourcegroups/default", - "location": "global", - "name": "default", - "tags": {}, - "type": "System.Resources/resourceGroups" - } - ] - } - ``` - -1. Update your request URL to [list all the Radius Environments]({{< ref api-environments >}}) in your resource group (_make sure to update the name of your resource group in the URL. In this example the resource group name is default_): - - ``` - <your-cluster-control-plane>/apis/api.ucp.dev/v1alpha3/planes/radius/local/resourcegroups/default/providers/Applications.Core/environments?api-version=2023-10-01-preview - ``` - - You should now see your Radius Environment(s): - - ``` - { - "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" - } - ] - } - ``` - -## Next step: Explore the Radius API - -Now that you have successfully authenticated to the Radius API and interacted with resources, you can explore the API using the [Radius API reference]({{< ref "api" >}}). diff --git a/docs/content/guides/operations/control-plane/howto-postman/postman-auth.png b/docs/content/guides/operations/control-plane/howto-postman/postman-auth.png deleted file mode 100644 index a5131bbf1..000000000 Binary files a/docs/content/guides/operations/control-plane/howto-postman/postman-auth.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/howto-postman/postman-url.png b/docs/content/guides/operations/control-plane/howto-postman/postman-url.png deleted file mode 100644 index bdc651bf9..000000000 Binary files a/docs/content/guides/operations/control-plane/howto-postman/postman-url.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/_index.md b/docs/content/guides/operations/control-plane/logs/_index.md deleted file mode 100644 index d5ce5501f..000000000 --- a/docs/content/guides/operations/control-plane/logs/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Control plane logging" -linkTitle: "Logs" -weight: 200 -description: "How to setup logging for the Radius control plane" ---- \ No newline at end of file diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/fluentd-config-map.yaml b/docs/content/guides/operations/control-plane/logs/fluentd/fluentd-config-map.yaml deleted file mode 100644 index 79c0658b2..000000000 --- a/docs/content/guides/operations/control-plane/logs/fluentd/fluentd-config-map.yaml +++ /dev/null @@ -1,106 +0,0 @@ -apiVersion: v1 -kind: ConfigMap -metadata: - name: fluentd-config - namespace: kube-system -data: - fluent.conf: | - <match fluent.**> - @type null - </match> - - <match kubernetes.var.log.containers.**fluentd**.log> - @type null - </match> - - <match kubernetes.var.log.containers.**kube-system**.log> - @type null - </match> - - <match kubernetes.var.log.containers.**kibana**.log> - @type null - </match> - - <source> - @type tail - path /var/log/containers/*.log - pos_file fluentd-docker.pos - time_format %Y-%m-%dT%H:%M:%S - tag kubernetes.* - <parse> - @type multi_format - <pattern> - format json - time_key time - time_type string - time_format "%Y-%m-%dT%H:%M:%S.%NZ" - keep_time_key false - </pattern> - <pattern> - format regexp - expression /^(?<time>.+) (?<stream>stdout|stderr)( (?<logtag>.))? (?<log>.*)$/ - time_format '%Y-%m-%dT%H:%M:%S.%N%:z' - keep_time_key false - </pattern> - </parse> - </source> - - <filter kubernetes.**> - @type kubernetes_metadata - @id filter_kube_metadata - watch false - </filter> - - <filter kubernetes.var.log.containers.**> - @type parser - <parse> - @type json - format json - time_key time - time_type string - time_format "%Y-%m-%dT%H:%M:%S.%NZ" - keep_time_key false - </parse> - key_name log - replace_invalid_sequence true - emit_invalid_record_to_error true - reserve_data true - </filter> - - <match **> - @type elasticsearch - @id out_es - @log_level info - include_tag_key true - host "#{ENV['FLUENT_ELASTICSEARCH_HOST']}" - port "#{ENV['FLUENT_ELASTICSEARCH_PORT']}" - path "#{ENV['FLUENT_ELASTICSEARCH_PATH']}" - scheme "#{ENV['FLUENT_ELASTICSEARCH_SCHEME'] || 'http'}" - ssl_verify "#{ENV['FLUENT_ELASTICSEARCH_SSL_VERIFY'] || 'true'}" - ssl_version "#{ENV['FLUENT_ELASTICSEARCH_SSL_VERSION'] || 'TLSv1_2'}" - user "#{ENV['FLUENT_ELASTICSEARCH_USER'] || use_default}" - password "#{ENV['FLUENT_ELASTICSEARCH_PASSWORD'] || use_default}" - reload_connections "#{ENV['FLUENT_ELASTICSEARCH_RELOAD_CONNECTIONS'] || 'false'}" - reconnect_on_error "#{ENV['FLUENT_ELASTICSEARCH_RECONNECT_ON_ERROR'] || 'true'}" - reload_on_failure "#{ENV['FLUENT_ELASTICSEARCH_RELOAD_ON_FAILURE'] || 'true'}" - log_es_400_reason "#{ENV['FLUENT_ELASTICSEARCH_LOG_ES_400_REASON'] || 'false'}" - logstash_prefix "#{ENV['FLUENT_ELASTICSEARCH_LOGSTASH_PREFIX'] || 'radius'}" - logstash_dateformat "#{ENV['FLUENT_ELASTICSEARCH_LOGSTASH_DATEFORMAT'] || '%Y.%m.%d'}" - logstash_format "#{ENV['FLUENT_ELASTICSEARCH_LOGSTASH_FORMAT'] || 'true'}" - index_name "#{ENV['FLUENT_ELASTICSEARCH_LOGSTASH_INDEX_NAME'] || 'radius'}" - type_name "#{ENV['FLUENT_ELASTICSEARCH_LOGSTASH_TYPE_NAME'] || 'fluentd'}" - include_timestamp "#{ENV['FLUENT_ELASTICSEARCH_INCLUDE_TIMESTAMP'] || 'false'}" - template_name "#{ENV['FLUENT_ELASTICSEARCH_TEMPLATE_NAME'] || use_nil}" - template_file "#{ENV['FLUENT_ELASTICSEARCH_TEMPLATE_FILE'] || use_nil}" - template_overwrite "#{ENV['FLUENT_ELASTICSEARCH_TEMPLATE_OVERWRITE'] || use_default}" - sniffer_class_name "#{ENV['FLUENT_SNIFFER_CLASS_NAME'] || 'Fluent::Plugin::ElasticsearchSimpleSniffer'}" - request_timeout "#{ENV['FLUENT_ELASTICSEARCH_REQUEST_TIMEOUT'] || '5s'}" - <buffer> - flush_thread_count "#{ENV['FLUENT_ELASTICSEARCH_BUFFER_FLUSH_THREAD_COUNT'] || '8'}" - flush_interval "#{ENV['FLUENT_ELASTICSEARCH_BUFFER_FLUSH_INTERVAL'] || '5s'}" - chunk_limit_size "#{ENV['FLUENT_ELASTICSEARCH_BUFFER_CHUNK_LIMIT_SIZE'] || '2M'}" - queue_limit_length "#{ENV['FLUENT_ELASTICSEARCH_BUFFER_QUEUE_LIMIT_LENGTH'] || '32'}" - retry_max_interval "#{ENV['FLUENT_ELASTICSEARCH_BUFFER_RETRY_MAX_INTERVAL'] || '30'}" - retry_forever true - </buffer> - </match> diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/fluentd-radius-with-rbac.yaml b/docs/content/guides/operations/control-plane/logs/fluentd/fluentd-radius-with-rbac.yaml deleted file mode 100644 index 6771d5af2..000000000 --- a/docs/content/guides/operations/control-plane/logs/fluentd/fluentd-radius-with-rbac.yaml +++ /dev/null @@ -1,100 +0,0 @@ ---- -apiVersion: v1 -kind: ServiceAccount -metadata: - name: fluentd - namespace: kube-system - ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: ClusterRole -metadata: - name: fluentd - namespace: kube-system -rules: -- apiGroups: - - "" - resources: - - pods - - namespaces - verbs: - - get - - list - - watch - ---- -kind: ClusterRoleBinding -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: fluentd - namespace: default -roleRef: - kind: ClusterRole - name: fluentd - apiGroup: rbac.authorization.k8s.io -subjects: -- kind: ServiceAccount - name: fluentd - namespace: kube-system ---- -apiVersion: apps/v1 -kind: DaemonSet -metadata: - name: fluentd - namespace: kube-system - labels: - k8s-app: fluentd-logging - version: v1 -spec: - selector: - matchLabels: - k8s-app: fluentd-logging - version: v1 - template: - metadata: - labels: - k8s-app: fluentd-logging - version: v1 - spec: - serviceAccount: fluentd - serviceAccountName: fluentd - tolerations: - - key: node-role.kubernetes.io/master - effect: NoSchedule - containers: - - name: fluentd - image: fluent/fluentd-kubernetes-daemonset:v1.9.2-debian-elasticsearch7-1.0 - env: - - name: FLUENT_ELASTICSEARCH_HOST - value: "elasticsearch-master.radius-monitoring" - - name: FLUENT_ELASTICSEARCH_PORT - value: "9200" - - name: FLUENT_ELASTICSEARCH_SCHEME - value: "http" - - name: FLUENT_UID - value: "0" - resources: - limits: - memory: 200Mi - requests: - cpu: 100m - memory: 200Mi - volumeMounts: - - name: varlog - mountPath: /var/log - - name: varlibdockercontainers - mountPath: /var/lib/docker/containers - readOnly: true - - name: fluentd-config - mountPath: /fluentd/etc - terminationGracePeriodSeconds: 30 - volumes: - - name: varlog - hostPath: - path: /var/log - - name: varlibdockercontainers - hostPath: - path: /var/lib/docker/containers - - name: fluentd-config - configMap: - name: fluentd-config diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/index.md b/docs/content/guides/operations/control-plane/logs/fluentd/index.md deleted file mode 100644 index e6ac7453c..000000000 --- a/docs/content/guides/operations/control-plane/logs/fluentd/index.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -type: docs -title: "How-To: Set up Fluentd, Elastic search and Kibana in Kubernetes" -linkTitle: "Fluentd" -weight: 2000 -description: "How to install Fluentd, Elastic Search, and Kibana to search control plane logs in Kubernetes" -categories: "How-To" -tags: ["logs","observability"] ---- - -## Prerequisites - -- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) -- [kubectl](https://kubernetes.io/docs/tasks/tools/) -- [Helm 3](https://helm.sh/) - -## Install Elastic search and Kibana - -1. Create a Kubernetes namespace for monitoring tools - - ```bash - kubectl create namespace radius-monitoring - ``` - -1. Add the helm repo for Elastic Search - - ```bash - helm repo add elastic https://helm.elastic.co - helm repo update - ``` - -1. Install Elastic Search using Helm - - _By default, the chart creates three replicas which must be on different nodes. If your cluster has fewer than 3 nodes, specify a smaller number of replicas with the `--set replicas=1` flag:_ - - ```bash - helm install elasticsearch elastic/elasticsearch --version 7.17.3 -n radius-monitoring --set replicas=1 - ``` - - _If you are using minikube or simply want to disable persistent volumes for development purposes, you can do so with `--set persistence.enabled=false`:_ - - ```bash - helm install elasticsearch elastic/elasticsearch --version 7.17.3 -n radius-monitoring --set persistence.enabled=false,replicas=1 - ``` - -1. Install Kibana - - ```bash - helm install kibana elastic/kibana --version 7.17.3 -n radius-monitoring - ``` - -1. Ensure that Elastic Search and Kibana are running in your Kubernetes cluster - - ```bash - kubectl get pods -n radius-monitoring - ``` - - You should see: - - ``` - NAME READY STATUS RESTARTS AGE - elasticsearch-master-0 1/1 Running 0 6m58s - kibana-kibana-95bc54b89-zqdrk 1/1 Running 0 4m21s - ``` - -## Install Fluentd - -1. Install config map and Fluentd as a daemonset - - Download these config files: - - [fluentd-config-map.yaml](fluentd-config-map.yaml) - - [fluentd-radius-with-rbac.yaml](fluentd-radius-with-rbac.yaml) - - _Note: If you already have Fluentd running in your cluster, enable the nested json parser so that it can parse JSON-formatted logs from radius._ - - Apply the configurations to your cluster: - - ```bash - kubectl apply -f ./fluentd-config-map.yaml - kubectl apply -f ./fluentd-radius-with-rbac.yaml - ``` - -1. Ensure that Fluentd is running as a daemonset. The number of Fluentd instances should be the same as the number of cluster nodes. In the example below, there is only one node in the cluster: - - ```bash - kubectl get pods -n kube-system -w - ``` - - You should see: - - ``` - NAME READY STATUS RESTARTS AGE - coredns-6955765f44-cxjxk 1/1 Running 0 4m41s - coredns-6955765f44-jlskv 1/1 Running 0 4m41s - etcd-m01 1/1 Running 0 4m48s - fluentd-sdrld 1/1 Running 0 14s - ``` - -## Install Radius control plane - -Visit the [Kubernetes docs]({{< ref "guides/operations/kubernetes" >}}) to learn how to install the Radius control plane. By default, Radius has JSON logging enabled. - -For Kubernetes, you can install with the rad CLI: - -```bash -rad install kubernetes -``` - -## Search logs - -Once the Radius control plane is installed, you can search the logs using Kibana. - -_Note: There is a small delay for Elastic Search to index the logs that Fluentd sends. You may need to wait a minute and refresh to see your logs._ - -1. Port-forward from localhost to `svc/kibana-kibana` - - ```bash - kubectl port-forward svc/kibana-kibana 5601 -n radius-monitoring - ``` - - You should see: - - ``` - Forwarding from 127.0.0.1:5601 -> 5601 - Forwarding from [::1]:5601 -> 5601 - Handling connection for 5601 - Handling connection for 5601 - ``` - -1. Browse to `http://localhost:5601` - -1. Expand the drop-down menu and click **Management β†’ Stack Management** - - ![Stack Management item under Kibana Management menu options](kibana-1.png) - -1. On the Stack Management page, select **Data β†’ Index Management** and wait until `radius-*` is indexed. - - ![Index Management view on Kibana Stack Management page](kibana-2.png) - -1. Once `radius-*` is indexed, click on **Kibana β†’ Index Patterns** and then the **Create index pattern** button. - - ![Kibana create index pattern button](kibana-3.png) - -1. Define a new index pattern by typing `radius*` into the **Index Pattern name** field, then click the **Next step** button to continue. - - ![Kibana define an index pattern page](kibana-4.png) - -1. Configure the primary time field to use with the new index pattern by selecting the `@timestamp` option from the **Time field** drop-down. Click the **Create index pattern** button to complete creation of the index pattern. - - ![Kibana configure settings page for creating an index pattern](kibana-5.png) - -1. The newly created index pattern should be shown. Confirm that the fields of interest such as `scope`, `type`, `app_id`, `level`, etc. are being indexed by using the search box in the **Fields** tab. - - _Note: If you cannot find the indexed field, please wait. The time it takes to search across all indexed fields depends on the volume of data and size of the resource that the elastic search is running on._ - - ![View of created Kibana index pattern](kibana-6.png) - -1. To explore the indexed data, expand the drop-down menu and click **Analytics β†’ Discover**. - - ![Discover item under Kibana Analytics menu options](kibana-7.png) - -1. In the search box, type in a query string such as `scope:*` and click the **Refresh** button to view the results. - - _Note: This can take a long time. The time it takes to return all results depends on the volume of data and size of the resource that the elastic search is running on._ - - ![Using the search box in the Kibana Analytics Discover page](kibana-8.png) - -## References - -- [Fluentd for Kubernetes](https://docs.fluentd.org/v/0.12/articles/kubernetes-fluentd) -- [Elastic search helm chart](https://github.com/elastic/helm-charts/tree/master/elasticsearch) -- [Kibana helm chart](https://github.com/elastic/helm-charts/tree/master/kibana) -- [Kibana Query Language](https://www.elastic.co/guide/en/kibana/current/kuery-query.html) diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-1.png b/docs/content/guides/operations/control-plane/logs/fluentd/kibana-1.png deleted file mode 100644 index 738e88b53..000000000 Binary files a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-1.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-2.png b/docs/content/guides/operations/control-plane/logs/fluentd/kibana-2.png deleted file mode 100644 index e5318129a..000000000 Binary files a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-2.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-3.png b/docs/content/guides/operations/control-plane/logs/fluentd/kibana-3.png deleted file mode 100644 index fa4184e6a..000000000 Binary files a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-3.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-4.png b/docs/content/guides/operations/control-plane/logs/fluentd/kibana-4.png deleted file mode 100644 index a0fa13988..000000000 Binary files a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-4.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-5.png b/docs/content/guides/operations/control-plane/logs/fluentd/kibana-5.png deleted file mode 100644 index 37fee6b06..000000000 Binary files a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-5.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-6.png b/docs/content/guides/operations/control-plane/logs/fluentd/kibana-6.png deleted file mode 100644 index f9eacba7c..000000000 Binary files a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-6.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-7.png b/docs/content/guides/operations/control-plane/logs/fluentd/kibana-7.png deleted file mode 100644 index 96c871a90..000000000 Binary files a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-7.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-8.png b/docs/content/guides/operations/control-plane/logs/fluentd/kibana-8.png deleted file mode 100644 index abf2c11c1..000000000 Binary files a/docs/content/guides/operations/control-plane/logs/fluentd/kibana-8.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/logs/overview/overview.md b/docs/content/guides/operations/control-plane/logs/overview/overview.md deleted file mode 100644 index 1d5b7bdb0..000000000 --- a/docs/content/guides/operations/control-plane/logs/overview/overview.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -type: docs -title: "Overview: Control plane logs" -linkTitle: "Overview" -weight: 100 -description: "Learn about Radius logs for monitoring and troubleshooting the control plane." -categories: "Overview" -tags: ["logs","troubleshooting", "observability"] ---- - -The Radius control plane produces logs that you can use to monitor and troubleshoot the control plane. This document describes how to collect and search logs, as well as the log schema. - -## Log formats - -The Radius control plane outputs structured logs to stdout, either plain-text or JSON-formatted. By default, services produce JSON formatted logs. - -> If you want to use a search engine such as Elastic Search or Azure Monitor to search logs, it is strongly recommended to use JSON-formatted logs which the log collector and the search engine can parse using the built-in JSON parser. - -## Log collectors - -### Fluentd - -If you run the control plane in a Kubernetes cluster, [Fluentd](https://www.fluentd.org/) is a popular container log collector. You can use Fluentd with a [JSON parser plugin](https://docs.fluentd.org/parser/json) to parse Radius JSON-formatted logs. This [how-to]({{< ref fluentd.md >}}) shows how to configure Fluentd in your cluster. - -### Azure Monitor - -If you are using Azure Kubernetes Service, you can use the [built-in agent to collect logs with Azure Monitor](https://learn.microsoft.com/azure/aks/monitor-aks) without needing to install Fluentd. - -## Search engines - -### Elastic Search and Kibana - -If you use [Fluentd](https://www.fluentd.org/), we recommend using Elastic Search and Kibana. This [how-to]({{< ref fluentd.md >}}) shows how to set up Elastic Search and Kibana in your Kubernetes cluster. - -### Azure Monitor - -If you are using the Azure Kubernetes Service, you can use [Azure Monitor for containers](https://docs.microsoft.com/azure/azure-monitor/insights/container-insights-overview) without installing any additional monitoring tools. Also read [How to enable Azure Monitor for containers](https://learn.microsoft.com/azure/azure-monitor/containers/container-insights-onboard) - -## Log schema - -Control plane logs contain the following fields: - -| Field | Description | Example | -|---------------|-------------------|---------| -| `timestamp` | [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp | `2011-10-05T14:48:00.000Z` | -| `severity` | Log level. Available levels are info, warn, debug, and error. | `info` | -| `message` | Log message | `proxying request target: http://de-api.radius-system:6443` | -| `name` | Logging scope | `ucplogger.api` | -| `caller` | Service logging point | `planes/proxyplane.go:171` -| `version` | Control plane version | `0.18` | -| `serviceName` | Name of control plane service | `ucplogger` | -| `hostName` | Service host name | `ucp-77bc9b4cbb-nmjlz` | -| `resourceId` | The resourceId being affected, if applicable | `/apis/api.ucp.dev/v1alpha3/planes/deployments/local/resourcegroups/myrg/providers/Microsoft.Resources/deployments/rad-deploy-6c0d37b0-705e-454b-9167-877aa080e656` | -| `traceId` | [w3c traceId](https://www.w3.org/TR/trace-context/#trace-id). Used to uniquely identify a [distributed trace](https://www.w3.org/TR/trace-context/#dfn-distributed-traces) through a system. | `d1ba9c7d2326ee1b44eb0b8177ef554f` | -| `spanId` | [w3c spanId](https://www.w3.org/TR/trace-context/#parent-id) The ID of this request as known by the caller. Also known as `parent-id` in some tracing systems. | `ce52a91ed3c86c6d` | - -#### Example - -```json -{ - "severity": "info", - "timestamp": "2023-03-03T00:03:55.355Z", - "name": "ucplogger.api", - "caller": "planes/proxyplane.go:171", - "message": "proxying request target: http://de-api.radius-system:6443", - "serviceName": "ucplogger", - "version": "0.18", - "hostName": "ucp-77bc9b4cbb-nmjlz", - "resourceId": "/apis/api.ucp.dev/v1alpha3/planes/deployments/local/resourcegroups/myrg/providers/Microsoft.Resources/deployments/rad-deploy-6c0d37b0-705e-454b-9167-877aa080e656", - "traceId": "2435428bbf8533c68b122b1ef31bb42f", - "spanId": "30a88181fe683c00" -} -``` - -## References - -- [How-to: Set up Fluentd, Elastic search, and Kibana]({{< ref fluentd.md >}}) -- [How-to: Set up Azure Monitor for containers](https://learn.microsoft.com/azure/aks/monitor-aks) diff --git a/docs/content/guides/operations/control-plane/metrics/_index.md b/docs/content/guides/operations/control-plane/metrics/_index.md deleted file mode 100644 index 45f6e3e8d..000000000 --- a/docs/content/guides/operations/control-plane/metrics/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Control plane metrics" -linkTitle: "Metrics" -weight: 300 -description: "How to setup metrics for the Radius control plane" ---- \ No newline at end of file diff --git a/docs/content/guides/operations/control-plane/metrics/grafana/index.md b/docs/content/guides/operations/control-plane/metrics/grafana/index.md deleted file mode 100644 index 8c6d2eefc..000000000 --- a/docs/content/guides/operations/control-plane/metrics/grafana/index.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -type: docs -title: "How-To: Observe metrics with Grafana" -linkTitle: "Grafana" -weight: 3000 -description: "Learn how to view the Radius control-plane metrics in Grafana dashboards" -categories: "How-To" -tags: ["metrics", "observability"] ---- - -[Grafana](https://grafana.com/) is an open-source visualization and analytics tool that allows you to query, visualize, alert on, and explore your metrics. This guide will show you how to install Grafana and configure it to visualize the Radius control plane metrics from Prometheus. - -## Example dashboards - -There are two example dashboards that you can import into Grafana to quickly get started visualizing your metrics and then customize them to meet your needs. - -### Control plane overview - -The [radius-overview-dashboard.json](https://raw.githubusercontent.com/radius-project/radius/main/grafana/radius-overview-dashboard.json) template shows Radius and Deployment Engine statuses, including runtime, and server-side health: - -{{< image src="radius-overview-1.png" alt="1st screenshot of the Radius Overview Dashboard" width=1200 >}}<br/> - -{{< image src="radius-overview-2.png" alt="2nd screenshot of the Radius Overview Dashboard" width=1200 >}}<br/> - -### Resource provider overview - -The [radius-resource-provider-dashboard.json](https://raw.githubusercontent.com/radius-project/radius/main/grafana/radius-resource-provider-dashboard.json) template shows Radius Resource Provider status, including runtime, server-side, and operations health: - -{{< image src="radius-resource-provider-1.png" alt="1st screenshot of the Radius Resource Provider Dashboard" width=1200 >}}<br/> - -{{< image src="radius-resource-provider-2.png" alt="2nd screenshot of the Radius Resource Provider Dashboard" width=1200 >}}<br/> - -## Setup on Kubernetes - -### Pre-requisites - -- [Setup Prometheus]({{<ref prometheus.md>}}) on your Kubernetes cluster -- [Helm 3](https://helm.sh/) - -### Install Grafana - -1. Add the Grafana Helm repo: - - ```bash - helm repo add grafana https://grafana.github.io/helm-charts - helm repo update - ``` - -1. Install the chart: - - ```bash - helm install grafana grafana/grafana -n radius-monitoring - ``` - - If you are Minikube user or want to disable persistent volume for development purpose, you can disable it by using the following command instead: - - ```bash - helm install grafana grafana/grafana -n radius-monitoring --set persistence.enabled=false - ``` - -1. Retrieve the admin password for Grafana login: - - ```bash - kubectl get secret --namespace radius-monitoring grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo - ``` - - You will get a password similar to `cj3m0OfBNx8SLzUlTx91dEECgzRlYJb60D2evof1%`. Remove the `%` character from the password to get `cj3m0OfBNx8SLzUlTx91dEECgzRlYJb60D2evof1` as the admin password. - -1. Validate that Grafana is running in your cluster: - - ```bash - kubectl get pods -n radius-monitoring - ``` - - You should see something similar to the following: - - ``` - NAME READY STATUS RESTARTS AGE - grafana-c49889cff-x56vj 1/1 Running 0 5m10s - ... - ``` - -### Configure Prometheus as data source - -Now that Grafana is installed, you need to configure it to use Prometheus as a data source. - -1. Port-forward to your Grafana service: - - ```bash - kubectl port-forward svc/grafana 8080:80 -n radius-monitoring - ``` - -1. Open a browser to [`http://localhost:8080`](http://localhost:8080) - -1. Login to Grafana - - Username: `admin` - - Password: Password from above - -1. Select `Configuration` and `Data Sources` - -1. Add Prometheus as a data source. - -1. Get your Prometheus HTTP URL: - - The Prometheus HTTP URL follows the format `http://<prometheus service endpoint>.<namespace>` - - Start by getting the Prometheus server endpoint by running the following command: - - ```bash - kubectl get svc -n radius-monitoring - ``` - - You should see something similar to the following: - - ``` - NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - radius-prom-kube-state-metrics ClusterIP 10.0.174.177 <none> 8080/TCP 7d9h - radius-prom-prometheus-alertmanager ClusterIP 10.0.255.199 <none> 80/TCP 7d9h - radius-prom-prometheus-node-exporter ClusterIP None <none> 9100/TCP 7d9h - radius-prom-prometheus-pushgateway ClusterIP 10.0.190.59 <none> 9091/TCP 7d9h - radius-prom-prometheus-server ClusterIP 10.0.172.191 <none> 80/TCP 7d9h - grafana ClusterIP 10.0.15.229 <none> 80/TCP 5d5h - ``` - - In this example the server name is `radius-prom-prometheus-server` and the namespace is `radius-monitoring`, so the HTTP URL will be `http://radius-prom-prometheus-server.radius-monitoring`. - -1. Fill in the following settings: - - - Name: `Radius` - - HTTP URL: `http://radius-prom-prometheus-server.radius-monitoring` - - Default: On - -1. Click `Save & Test` button to verify that the connection succeeded. - -### Import dashboards in Grafana - -1. Download the Grafana dashboard templates: - - [radius-overview-dashboard.json](https://raw.githubusercontent.com/radius-project/radius/main/grafana/radius-overview-dashboard.json) - - [radius-resource-provider-dashboard.json](https://raw.githubusercontent.com/radius-project/radius/main/grafana/radius-resource-provider-dashboard.json) -1. In the upper left corner of the Grafana home screen, click the "+" option, then "Import", and select your templates. -1. Select the dashboard that you imported and enjoy! - -## References - -- [Prometheus Installation](https://github.com/prometheus-community/helm-charts) -- [Prometheus on Kubernetes](https://github.com/coreos/kube-prometheus) -- [Prometheus Query Language](https://prometheus.io/docs/prometheus/latest/querying/basics/) diff --git a/docs/content/guides/operations/control-plane/metrics/grafana/radius-overview-1.png b/docs/content/guides/operations/control-plane/metrics/grafana/radius-overview-1.png deleted file mode 100644 index 2ee2a2962..000000000 Binary files a/docs/content/guides/operations/control-plane/metrics/grafana/radius-overview-1.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/metrics/grafana/radius-overview-2.png b/docs/content/guides/operations/control-plane/metrics/grafana/radius-overview-2.png deleted file mode 100644 index 68e0475ef..000000000 Binary files a/docs/content/guides/operations/control-plane/metrics/grafana/radius-overview-2.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/metrics/grafana/radius-resource-provider-1.png b/docs/content/guides/operations/control-plane/metrics/grafana/radius-resource-provider-1.png deleted file mode 100644 index db348c98e..000000000 Binary files a/docs/content/guides/operations/control-plane/metrics/grafana/radius-resource-provider-1.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/metrics/grafana/radius-resource-provider-2.png b/docs/content/guides/operations/control-plane/metrics/grafana/radius-resource-provider-2.png deleted file mode 100644 index 945339e8b..000000000 Binary files a/docs/content/guides/operations/control-plane/metrics/grafana/radius-resource-provider-2.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/metrics/overview/index.md b/docs/content/guides/operations/control-plane/metrics/overview/index.md deleted file mode 100644 index 190f25b04..000000000 --- a/docs/content/guides/operations/control-plane/metrics/overview/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -type: docs -title: "Overview: Control plane metrics" -linkTitle: "Overview" -weight: 200 -description: "Learn about Radius control plane metrics" -categories: ["Overview"] ---- - -Radius emits metrics from the control-plane which can be used for troubleshooting and monitoring. - -## Available metrics - -Refer to the [metrics reference]({{< ref "/reference/metrics" >}}) for a list of available metrics. diff --git a/docs/content/guides/operations/control-plane/metrics/prometheus/index.md b/docs/content/guides/operations/control-plane/metrics/prometheus/index.md deleted file mode 100644 index 809f65469..000000000 --- a/docs/content/guides/operations/control-plane/metrics/prometheus/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -type: docs -title: "How-To: Collect metrics with Prometheus" -linkTitle: "Prometheus" -weight: 2000 -description: "Use Prometheus to collect time-series data from the Radius control plane" -categories: "How-To" -tags: ["metrics", "observability"] ---- - -[Prometheus](https://prometheus.io/) collects and stores metrics as time series data. This guide will show you how to collect Radius control plane metrics to then be visualized and queried. - -## Install Prometheus on Kubernetes - -1. Make sure you have the following pre-requisites: - - - [Supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) - - [kubectl](https://kubernetes.io/docs/tasks/tools/) - - [Helm 3](https://helm.sh/) - - [Radius control plane installed]({{< ref kubernetes-install >}}) - -1. Create a namespace that can be used to deploy the Grafana and Prometheus monitoring tools: - - ```bash - kubectl create namespace radius-monitoring - ``` - -1. Install Prometheus into your monitoring namespace: - - ```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 - ``` - - If you are Minikube user or want to disable persistent volume for development purposes, you can disable it by using the following command. - - ```bash - helm install radius-prom prometheus-community/prometheus -n radius-monitoring --set alertmanager.persistentVolume.enable=false --set pushgateway.persistentVolume.enabled=false --set server.persistentVolume.enabled=false - ``` - -1. Validate your Prometheus installation: - - ```bash - kubectl get pods -n radius-monitoring - ``` - - You should see something similar to the following: - - ``` - NAME READY STATUS RESTARTS AGE - radius-prom-kube-state-metrics-9849d6cc6-t94p8 1/1 Running 0 4m58s - radius-prom-prometheus-alertmanager-749cc46f6-9b5t8 2/2 Running 0 4m58s - radius-prom-prometheus-node-exporter-5jh8p 1/1 Running 0 4m58s - radius-prom-prometheus-node-exporter-88gbg 1/1 Running 0 4m58s - radius-prom-prometheus-node-exporter-bjp9f 1/1 Running 0 4m58s - radius-prom-prometheus-pushgateway-688665d597-h4xx2 1/1 Running 0 4m58s - radius-prom-prometheus-server-694fd8d7c-q5d59 2/2 Running 0 4m58s - ``` - -1. Done! Prometheus is now installed and ready to collect metrics from the Radius control plane. - -## Next step: Add a Grafana dashboard - -Now that you have Prometheus installed, you can visualize the metrics using Grafana. Follow the [Grafana installation guide]({{< ref grafana >}}) to get up and running with a Grafana dashboard. - -{{< button page="grafana" text="Next: Add a Grafana dashboard" >}} - -## Further reading - -* [Prometheus Installation](https://github.com/prometheus-community/helm-charts) -* [Prometheus Query Language](https://prometheus.io/docs/prometheus/latest/querying/basics/) \ No newline at end of file diff --git a/docs/content/guides/operations/control-plane/traces/_index.md b/docs/content/guides/operations/control-plane/traces/_index.md deleted file mode 100644 index 080091904..000000000 --- a/docs/content/guides/operations/control-plane/traces/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Control plane tracing" -linkTitle: "Tracing" -weight: 400 -description: "How to setup your observability tools to receive Radius control plane traces" ---- \ No newline at end of file diff --git a/docs/content/guides/operations/control-plane/traces/jaeger/index.md b/docs/content/guides/operations/control-plane/traces/jaeger/index.md deleted file mode 100644 index 990781622..000000000 --- a/docs/content/guides/operations/control-plane/traces/jaeger/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -type: docs -title: "How-To: Set up Jaeger for distributed tracing" -linkTitle: "Jaeger" -description: "Learn how to deploy and set up Jaeger for distributed tracing" -categories: "How-To" -tags: ["tracing", "observability"] ---- - -[Jaeger](https://www.jaegertracing.io/) is an open-source distributed tracing system. It helps gather timing data needed to troubleshoot latency problems in microservice architectures. It manages both the collection and lookup of this data. - -The following steps show you how to configure the Radius control plane to send distributed tracing data to Jaeger running as a container in your Kubernetes cluster and how to view the data. - -## Pre-requisites - -- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/) - -## Step 1: Install Jaeger on Kubernetes - -1. Create the namespace `radius-monitoring`: - - ```bash - kubectl create namespace radius-monitoring - ``` - -1. Create the file `jaeger.yaml`, and paste the following YAML: - - {{< button text="Download jaeger.yaml" link="jaeger.yaml" >}} - -1. Install Jaeger: - - ```bash - kubectl apply -f jaeger.yaml - ``` - -1. Wait for Jaeger to be up and running - - ```bash - kubectl wait deploy --selector app=jaeger --for=condition=available -n radius-monitoring - ``` - -## Step 2: Configure Radius control plane - -1. Install the Radius control plane with your Zipkin endpoint set to your Jaeger collector endpoint using [`rad install kubernetes`]({{< ref rad_install_kubernetes >}}): - - ```bash - rad install kubernetes --set global.zipkin.url=http://jaeger-collector.radius-monitoring.svc.cluster.local:9411/api/v2/spans - ``` - - > **Note:** `http://jaeger-collector.radius-monitoring.svc.cluster.local:9411/api/v2/spans` is the default URL for Jaeger when installed using the above instructions. If you have changed the service name or namespace, use that instead. - -## Step 3: View Tracing Data - -1. Port forward the Jaeger service to your local machine: - - ```bash - kubectl port-forward svc/tracing 16686 -n radius-monitoring - ``` - -1. In your browser, go to [http://localhost:16686](http://localhost:16686) to see the Jaeger UI: - - {{< image src="jaeger_ui.png" alt="" style="width:100%" >}} - -## References - -- [Jaeger Getting Started](https://www.jaegertracing.io/docs/1.21/getting-started/#all-in-one) diff --git a/docs/content/guides/operations/control-plane/traces/jaeger/jaeger.yaml b/docs/content/guides/operations/control-plane/traces/jaeger/jaeger.yaml deleted file mode 100644 index 2a62a7a70..000000000 --- a/docs/content/guides/operations/control-plane/traces/jaeger/jaeger.yaml +++ /dev/null @@ -1,116 +0,0 @@ -apiVersion: apps/v1 -kind: Deployment -metadata: - name: jaeger - namespace: radius-monitoring - labels: - app: jaeger -spec: - selector: - matchLabels: - app: jaeger - template: - metadata: - labels: - app: jaeger - annotations: - prometheus.io/scrape: "true" - prometheus.io/port: "14269" - spec: - containers: - - name: jaeger - image: "docker.io/jaegertracing/all-in-one:1.42" - env: - - name: BADGER_EPHEMERAL - value: "false" - - name: SPAN_STORAGE_TYPE - value: "badger" - - name: BADGER_DIRECTORY_VALUE - value: "/badger/data" - - name: BADGER_DIRECTORY_KEY - value: "/badger/key" - - name: COLLECTOR_ZIPKIN_HOST_PORT - value: ":9411" - - name: MEMORY_MAX_TRACES - value: "50000" - - name: QUERY_BASE_PATH - value: /jaeger - livenessProbe: - httpGet: - path: / - port: 14269 - readinessProbe: - httpGet: - path: / - port: 14269 - volumeMounts: - - name: data - mountPath: /badger - resources: - requests: - cpu: 10m - volumes: - - name: data - emptyDir: {} ---- -apiVersion: v1 -kind: Service -metadata: - name: tracing - namespace: radius-monitoring - labels: - app: jaeger -spec: - type: ClusterIP - ports: - - name: http-query - port: 16686 - protocol: TCP - targetPort: 16686 - # Note: Change port name if you add '--query.grpc.tls.enabled=true' - - name: grpc-query - port: 16685 - protocol: TCP - targetPort: 16685 - selector: - app: jaeger ---- -# Jaeger implements the Zipkin API. To support swapping out the tracing backend, we use a Service named Zipkin. -apiVersion: v1 -kind: Service -metadata: - labels: - name: zipkin - name: zipkin - namespace: radius-monitoring -spec: - ports: - - port: 9411 - targetPort: 9411 - name: http-query - selector: - app: jaeger ---- -apiVersion: v1 -kind: Service -metadata: - name: jaeger-collector - namespace: radius-monitoring - labels: - app: jaeger -spec: - type: ClusterIP - ports: - - name: jaeger-collector-http - port: 14268 - targetPort: 14268 - protocol: TCP - - name: jaeger-collector-grpc - port: 14250 - targetPort: 14250 - protocol: TCP - - port: 9411 - targetPort: 9411 - name: http-zipkin - selector: - app: jaeger diff --git a/docs/content/guides/operations/control-plane/traces/jaeger/jaeger_ui.png b/docs/content/guides/operations/control-plane/traces/jaeger/jaeger_ui.png deleted file mode 100644 index c43047b25..000000000 Binary files a/docs/content/guides/operations/control-plane/traces/jaeger/jaeger_ui.png and /dev/null differ diff --git a/docs/content/guides/operations/control-plane/traces/zipkin/index.md b/docs/content/guides/operations/control-plane/traces/zipkin/index.md deleted file mode 100644 index ba4ae41c4..000000000 --- a/docs/content/guides/operations/control-plane/traces/zipkin/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -type: docs -title: "How-To: Set up Zipkin for distributed tracing" -linkTitle: "Zipkin" -description: "Learn how to deploy and set up Zipkin for distributed tracing" -categories: "How-To" -tags: ["tracing", "observability"] ---- - -[Zipkin](https://zipkin.io/) is an open-source distributed tracing system. It helps gather timing data needed to troubleshoot latency problems in microservice architectures. It manages both the collection and lookup of this data. - -The following steps show you how to configure Radius to send distributed tracing data to Zipkin running as a container in your Kubernetes cluster and how to view the data. - -## Pre-requisites - -- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/) - -## Step 1: Install Zipkin on Kubernetes - -1. Create the namespace `radius-monitoring`: - - ```bash - kubectl create namespace radius-monitoring - ``` - -1. Deploy the Zipkin deployment and service: - - ```bash - kubectl create deployment zipkin --image openzipkin/zipkin -n radius-monitoring - ``` - - ```bash - kubectl expose deployment zipkin --type ClusterIP --port 9411 -n radius-monitoring - ``` - -## Step 2: Configure Radius control plane - -1. Install the Radius control plane with your Zipkin endpoint set using [`rad install kubernetes`]({{< ref rad_install_kubernetes >}}): - - ```bash - rad install kubernetes --set global.zipkin.url=http://zipkin.radius-monitoring.svc.cluster.local:9411/api/v2/spans - ``` - - > **Note:** `http://zipkin.radius-monitoring.svc.cluster.local:9411/api/v2/spans` is the default URL for Zipkin when installed using the above instructions. If you have changed the service name or namespace, use that instead. - -## Step 3: View Tracing Data - -1. Port forward the Zipkin service to your local machine: - - ```bash - kubectl port-forward svc/zipkin 9411:9411 -n radius-monitoring - ``` - -1. In your browser, go to [http://localhost:9411](http://localhost:9411) to see the Zipkin UI and run a query: - - {{< image src="zipkin_ui.png" alt="" style="width:100%" >}} - -1. Done! You can now use the Zipkin UI to view tracing data for your Radius control plane. - -## References - -- [Zipkin for distributed tracing](https://zipkin.io/) diff --git a/docs/content/guides/operations/control-plane/traces/zipkin/zipkin_ui.png b/docs/content/guides/operations/control-plane/traces/zipkin/zipkin_ui.png deleted file mode 100644 index 94993c1f7..000000000 Binary files a/docs/content/guides/operations/control-plane/traces/zipkin/zipkin_ui.png and /dev/null differ diff --git a/docs/content/guides/operations/groups/_index.md b/docs/content/guides/operations/groups/_index.md deleted file mode 100644 index 0d01fa5e0..000000000 --- a/docs/content/guides/operations/groups/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Resource groups" -linkTitle: "Resource groups" -description: "Manage collections of resources with resource groups" -weight: 600 ---- diff --git a/docs/content/guides/operations/groups/howto-resourcegroups/index.md b/docs/content/guides/operations/groups/howto-resourcegroups/index.md deleted file mode 100644 index 7ff18769e..000000000 --- a/docs/content/guides/operations/groups/howto-resourcegroups/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -type: docs -title: "How-To: Manage resource groups" -linkTitle: "Manage groups" -description: "Learn how to manage resource groups in Radius" -weight: 200 -categories: "How-To" ---- - -This guide will walk you through the process of managing resource groups in Radius. For more information on resource groups, see [Resource groups]({{< ref groups >}}). - -## Pre-requisites - -- [Supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) - -## Step 1: Ensure Radius is installed - -Begin by making sure that Radius is installed on your Kubernetes cluster: - -```bash -rad install kubernetes -``` - -## Step 2: Create a resource group - -Run [`rad group create`]({{< ref rad_group_create >}}) to create a resource group: - -```bash -rad group create myGroup -``` - -You should see: - -``` -creating resource group "myGroup" in namespace "default"... - -resource group "myGroup" created -``` - -## Step 3: View your resource group - -Run [`rad group show`]({{< ref rad_group_show >}}) to view the your resource group: - -```bash -rad group show myGroup -``` - -You should see: - -``` -ID NAME -/planes/radius/local/resourcegroups/myGroup myGroup -``` - -You can use the `-o json` flag to view more information about the resource group: - -```bash -rad group show -o json -``` - -You should see: - -``` -{ - "id": "/planes/radius/local/resourcegroups/myGroup", - "location": "global", - "name": "myGroup", - "tags": {}, - "type": "System.Resources/resourceGroups", -} -``` - -## Step 4: Set your resource group as the default - -Setting a default resource group allows you to run commands like `rad deploy` without specifying the `-g/--group` flag explicitly every time. Run [`rad group switch`]({{< ref rad_group_switch >}}) to set your new resource group as the default: - -```bash -rad group switch myGroup -``` - -You can now run `rad deploy` or `rad recipe list` without needing to specify the group. - -## Step 5: Delete your resource group - -Run [`rad group delete`]({{< ref rad_group_delete >}}) to delete a resource group: - -```bash -rad group delete myGroup -``` diff --git a/docs/content/guides/operations/groups/overview/group-diagram.png b/docs/content/guides/operations/groups/overview/group-diagram.png deleted file mode 100644 index de98e6b15..000000000 Binary files a/docs/content/guides/operations/groups/overview/group-diagram.png and /dev/null differ diff --git a/docs/content/guides/operations/groups/overview/group.svg b/docs/content/guides/operations/groups/overview/group.svg deleted file mode 100644 index c50254ec1..000000000 --- a/docs/content/guides/operations/groups/overview/group.svg +++ /dev/null @@ -1,18 +0,0 @@ -<svg id="a685cc8c-32ba-4d54-91da-3a125cb58ded" xmlns="http://www.w3.org/2000/svg" width="18" height="18" viewBox="0 0 18 18"> - <title>Icon-general-7 - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/content/guides/operations/groups/overview/index.md b/docs/content/guides/operations/groups/overview/index.md deleted file mode 100644 index f6d362388..000000000 --- a/docs/content/guides/operations/groups/overview/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -type: docs -title: "Overview: Resource groups" -linkTitle: "Overview" -description: "Learn how to manage collections of resources with resource groups" -weight: 100 ---- - -Resource groups are collections of resources that you can manage as a single unit. You can use resource groups to organize your resources when deploying Radius Applications. - -{{< image src="group-diagram.png" alt="Diagram showing Radius resources inside of a Radius resource group" width=600px >}} - -{{% alert title="Radius vs. Azure Resource Groups" color="primary" %}} -Note that resource groups in Radius are not the same as [Azure resource groups](https://learn.microsoft.com/azure/azure-resource-manager/management/manage-resource-groups-portal). Azure resource groups are used to organize Azure resources, while Radius resource groups are used to organize Radius resources, such as applications, environments, portable resources, and routes. When you deploy a template that contains both, Radius resources route to the Radius resource group defined in your workspace, and Azure resources route to the Azure resource group defined in your [cloud provider]({{< ref providers >}}). -{{% /alert %}} - -## Initialization - -As part of `rad init`, a default resource group is created for you, with the same name as your environment. This resource group is set as the default 'scope' of your [workspace]({{< ref workspaces >}}), so that all Radius resources you deploy will be created in this resource group. - -## Manage groups with rad CLI - -The rad CLI provides commands for managing resource groups. You can use the [`rad group`]({{< ref rad_group >}}) commands to create, list, and delete groups: - -{{< tabs create list show delete switch >}} - -{{% codetab %}} -[rad group create]({{< ref rad_group_create >}}) creates a new resource group: - -```bash -rad group create myrg -``` -{{% /codetab %}} - -{{% codetab %}} -[rad group list]({{< ref rad_group_list >}}) lists all of the resource groups in your Radius installation: - -```bash -rad group list -``` -{{% /codetab %}} - -{{% codetab %}} -[rad group show]({{< ref rad_group_show >}}) prints information on a resource group: - -```bash -rad group show -``` -{{% /codetab %}} - -{{% codetab %}} -[rad group delete]({{< ref rad_group_delete >}}) deletes the specified resource group: - -```bash -rad group delete -e mygroup -``` -{{% /codetab %}} - -{{% codetab %}} -[rad group switch]({{< ref rad_group_switch >}}) switches the default resource group in your [workspace]({{< ref workspaces >}}): - -```bash -rad group switch mygroup -``` -{{% /codetab %}} - -{{< /tabs >}} diff --git a/docs/content/guides/operations/kubernetes/_index.md b/docs/content/guides/operations/kubernetes/_index.md deleted file mode 100644 index 7853afc35..000000000 --- a/docs/content/guides/operations/kubernetes/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Kubernetes platform" -linkTitle: "Kubernetes" -description: "Learn how Radius can run on Kubernetes" -weight: 10 ---- diff --git a/docs/content/guides/operations/kubernetes/kubernetes-install/index.md b/docs/content/guides/operations/kubernetes/kubernetes-install/index.md deleted file mode 100644 index 960a9e740..000000000 --- a/docs/content/guides/operations/kubernetes/kubernetes-install/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -type: docs -title: "How-To: Install Radius on Kubernetes" -linkTitle: "Installation" -description: "Learn how to setup Radius on supported Kubernetes clusters" -weight: 200 -categories: "How-To" -tags: ["Kubernetes"] -slug: 'install' ---- - -Radius handles the deployment and management of environments, applications, and other resources with components that are installed into the Kubernetes cluster. - -## Prerequisites - -- [Kubernetes cluster]({{< ref "guides/operations/kubernetes/overview#supported-kubernetes-clusters" >}}) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- [rad CLI]({{< ref howto-rad-cli >}}) - -## Install with the rad CLI - -Use the [`rad install kubernetes` command]({{< ref rad_install_kubernetes >}}) to install Radius into the `radius-system` namespace on your Kubernetes cluster. You can optionally use the `--set` flag to customize the installation with [Helm configuration options](#helm-configuration-options): - -```bash -# Install Radius -rad install kubernetes - -# Install Radius with tracing and public endpoint override -rad install kubernetes --set global.zipkin.url=http://jaeger-collector.radius-monitoring.svc.cluster.local:9411/api/v2/spans,rp.publicEndpointOverride=localhost:8081 -``` - -### Use your own root certificate authority certificate - -Many enterprises leverage intermediate root certificate authorities (CAs) to enhance security and control over outgoing traffic originating from their employees' machines, particularly when using a firewall or proxy solution. For example, some enterprises may choose to issue CAs per org and control the traffic per org. In this setup, when Radius attempts to connect to an external endpoint, such as Azure or AWS, traffic is blocked by the firewall. You may optionally use`--set-file` when installing Radius to inject your root CA certificates into Radius: - -```bash -rad install kubernetes --set-file global.rootCA.cert=/etc/ssl/your-root-ca.crt -``` - -## Install with Helm - -1. Begin by adding the Radius Helm repository: - - ```bash - helm repo add radius oci://ghcr.io/radius-project/helm-chart - helm repo update - ``` - -1. Get all available versions: - - ```bash - helm search repo radius --versions - ``` - -1. Install the specified chart: - - ```bash - helm upgrade radius radius/radius --install --create-namespace --namespace radius-system --version {{< param chart_version >}} --wait --timeout 15m0s - ``` - -### Helm configuration options - -| Name | Default | Description | -|------|---------|-------------| -| `global.zipkin.url` | | Zipkin collector URL. If not specified, tracing is disabled. -| `global.prometheus.enabled` | `true` | Enables Prometheus metrics. Defaults to `true` -| `global.prometheus.path` | `"/metrics"` | Metrics endpoint -| `global.prometheus.port` | `9090` | Metrics port -| `global.rootCA.cert` | | Root CA certificate which will be injected to Radius containers. Use `--set-file global.rootCA.cert=[cert file]` -| `rp.image` | `ghcr.io/radius-project/applications-rp:latest` //TODO | Location of the Radius resource provider (RP) image -| `rp.tag` | `latest` | Tag of the Radius resource provider (RP) image -|`rp.publicEndpointOverride` | `""` | Public endpoint of the Kubernetes cluster. Overrides the default behavior of automatically detecting the public endpoint. -| `de.image` | `ghcr.io/radius-project/deployment-engine` | Location of the Bicep deployment engine (DE) image -| `de.tag` | `latest` | Tag of the Bicep deployment engine (DE) image -| `ucp.image` | `ghcr.io/radius-project/ucpd` | Location of universal control plane (UCP) image -| `ucp.tag` | `latest` | Tag of the universal control plane (UCP) image diff --git a/docs/content/guides/operations/kubernetes/kubernetes-metadata/index.md b/docs/content/guides/operations/kubernetes/kubernetes-metadata/index.md deleted file mode 100644 index 226939407..000000000 --- a/docs/content/guides/operations/kubernetes/kubernetes-metadata/index.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -type: docs -title: "How-To: Set Kubernetes metadata" -linkTitle: "Kubernetes metadata" -description: "Learn how to configure Kubernetes labels and annotations for generated objects" -weight: 500 -categories: "How-To" -tags: ["containers","Kubernetes","applications","environments"] ---- - -## Background - -[Kubernetes Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) are key/value pairs attached to Kubernetes objects and used to identify groups of related resources by organizational structure, release, process etc. Labels are descriptive in nature and can be queried. - -[Kubernetes Annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) attach non-identifying information to Kubernetes objects. They are used to provide additional information to users and can also be used for operational purposes. Annotations are used to represent behavior that can be leveraged by tools and libraries and often they are not human readable or queried. - -## Kubernetes metadata extension - -Radius enables you to retain or use your own defined tagging scheme for Kubernetes resources using Kubernetes labels and annotations. This enables users to incrementally adopt Radius for microservices built in the Kubernetes ecosystem using Kubernetes metadata concepts. - -You can set labels and annotations on an environment, application, or container using the Kubernetes metadata extension. The Kubernetes objects output from your resources (_Deployments, Services, etc._) will now have the defined metadata. - -{{< tabs Environment Application Container >}} - -{{% codetab %}} -{{< rad file="snippets/env.bicep" embed=true marker="//ENV" >}} -{{% /codetab %}} - -{{% codetab %}} -{{< rad file="snippets/env.bicep" embed=true marker="//APP" >}} -{{% /codetab %}} - -{{% codetab %}} -{{< rad file="snippets/env.bicep" embed=true marker="//CONTAINER" >}} -{{% /codetab %}} - -{{< /tabs >}} - -## Cascading metadata - -Kubernetes metadata can be applied at the environment, application, or container layers. Metadata cascades down from the environment to the application to the containers, gateway and route resources. For example, you can set labels and annotations at an environment level and all containers within the environment will gain these labels and annotation, without the need for an explicit extension on the containers. The following resources will gain the Kubernetes metadata for their [output resources]({{< ref "/guides/operations/kubernetes/overview#resource-mapping" >}}) from labels, annotations set at Environment, Application levels: - -- Applications.Core/containers -- Applications.Core/gateways - -### Metadata processing order - -Labels and annotations are processed in the following order, combining the keys/values at each level: - -1. Environment -1. Application -1. Container - -### Conflicts and overrides - -In the case where layers have conflicting keys (_i.e. Application and Container both specify a `myapp.team.name` label_), the last level to process wins out and overrides other values (container). The metadata specified on the container will override the metadata specified on the application or environment. - -## Reserved keys - -Certain labels/annotations have special uses to Radius internally and are not allowed to be overridden by user. Labels/Annotations with keys that have a prefix : `radapp.io/` will be ignored during processing. - -## Extension processing order - -Other extensions may set Kubernetes metadata. For example, the `daprSidecar` extension sets the `dapr.io/enabled` annotation, as well as some others. This may cause issues in the case of conflicts. - -The order in which extensions are executed is as follows, from first to last: - -1. Dapr sidecar extension -1. Manual scale extension -1. Kubernetes metadata extension - -### Conflicts - -When labels/annotation have the same set of key(s) added by two or more extensions, the final value is determined by the last extension that is processed. - -## Example - -Let's take an example of an application with some labels and annotations. This example shows some generic 'keys', as well as an example of how an organization may use labels to track organization contact information inside labels for troubleshooting scenarios: - -{{< rad file="snippets/env.bicep" embed=true marker="//APP" >}} - -All resources within this application with Kubernetes outputs will gain these labels. Let's now take a look at a frontend container, where the frontend team has overridden some of the values: - -{{< rad file="snippets/env.bicep" embed=true marker="//CONTAINER" >}} - -When this file is deployed, the metadata on the `frontend` deployment is: - -```bash -$ kubectl describe deployment frontend -Name: frontend -Namespace: default-myapp -Labels: key1=appValue1 - key2=containerValue2 - team.contact.name=Frontend - team.contact.alias=frontend-eng - radapp.io/application=myapp - radapp.io/resource=frontend - radapp.io/resource-type=applications.core-containers - ... -Annotations: prometheus.io/port: 9090 - prometheus.io/scrape: true - ... -``` - -The labels & annotations were set based on the following: - -| Key | Value | Description | -|-----|-------|-------------| -| **Labels** -| `team.key1` | `appValue1` | Application value is applied -| `team.key2` | `containerValue2` | Container value overrides application value -| `team.contact.name` | `Frontend` | Container value overrides application value -| `team.contact.alias` | `frontend-eng` | Container value overrides application value -| `radapp.io/application` | `myapp` | Radius-injected label -| `radapp.io/resource` | `frontend` | Radius-injected label -| `radapp.io/resource-type` | `applications.core-containers` | Radius-injected label -| **Annotations** -| `prometheus.io/port` | `9090` | Application annotation is applied -| `prometheus.io/scrape` | `true`| Application annotation is applied diff --git a/docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep b/docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep deleted file mode 100644 index 9795c81ea..000000000 --- a/docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep +++ /dev/null @@ -1,68 +0,0 @@ -extension radius - -//ENV -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'myenv' - properties: { - compute: { - kind: 'kubernetes' - namespace: 'my-ns' - } - extensions: [ - { - kind: 'kubernetesMetadata' - labels: { - 'team.key1': 'envValue1' - 'team.key2': 'envValue2' - } - } - ] - } -} -//ENV - -//APP -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: env.id - extensions: [ - { - kind: 'kubernetesMetadata' - labels: { - 'team.key1': 'appValue1' - 'team.key2': 'appValue2' - 'team.contact.name': 'Operations' - 'team.contact.alias': 'ops' - } - annotations: { - 'prometheus.io/port': '9090' - 'prometheus.io/scrape': 'true' - } - } - ] - } -} -//APP - -//CONTAINER -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: app.id - container: { - image: 'myregistry/mycontainer:latest' - } - extensions: [ - { - kind: 'kubernetesMetadata' - labels: { - 'team.key2': 'containerValue2' - 'team.contact.name': 'Frontend' - 'team.contact.alias': 'frontend-eng' - } - } - ] - } -} -//CONTAINER diff --git a/docs/content/guides/operations/kubernetes/kubernetes-rollback/index.md b/docs/content/guides/operations/kubernetes/kubernetes-rollback/index.md deleted file mode 100644 index 94214d97a..000000000 --- a/docs/content/guides/operations/kubernetes/kubernetes-rollback/index.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -type: docs -title: "How-To: Rollback Radius on Kubernetes" -linkTitle: "Rollback Radius on Kubernetes" -description: "Learn how to rollback Radius to a previous version on Kubernetes" -weight: 350 -categories: "How-To" -tags: ["Kubernetes"] ---- - -Radius supports rolling back to previous versions on Kubernetes clusters using the `rad rollback kubernetes` command. This feature allows you to quickly revert to a known-good version if issues are encountered after an upgrade. - -## Prerequisites - -- [Radius installed on Kubernetes cluster]({{< ref "guides/operations/kubernetes/kubernetes-install" >}}) -- [rad CLI]({{< ref howto-rad-cli >}}) -- Previous Radius installation to rollback to - -## Understanding Helm revisions - -Radius uses Helm for installation and upgrades on Kubernetes. Each installation or upgrade creates a new Helm revision. These revisions serve as restore points that you can rollback to if needed. - -To view the revision history: - -```bash -# List all Radius Helm revisions -helm history radius -n radius-system - -# Example output: -# REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION -# 1 Mon Oct 2 10:00:00 2024 superseded radius-0.48 0.48 Install complete -# 2 Mon Oct 9 11:00:00 2024 superseded radius-0.49 0.49 Upgrade complete -# 3 Mon Oct 16 12:00:00 2024 deployed radius-0.50 0.50 Upgrade complete -``` - -## Step 1: Check current version and available revisions - -Before rolling back, check your current Radius version and available revisions: - -```bash -# Check current version -rad version - -# List available revisions using rad CLI -rad rollback kubernetes --list-revisions - -# Alternatively, view Helm revision history directly -helm history radius -n radius-system -``` - -## Step 2: Rollback to a previous version - -Use the `rad rollback kubernetes` command to rollback to a specific revision: - -```bash -# Rollback to the previous revision (revision 0 or omit --revision flag) -rad rollback kubernetes - -# Rollback to the previous revision explicitly using revision 0 -rad rollback kubernetes --revision 0 - -# Rollback to a specific revision number -rad rollback kubernetes --revision 3 - -# Switch workspace before rolling back (if needed) -rad workspace switch myworkspace -rad rollback kubernetes --revision 2 -``` - -The rollback process will: - -1. Revert the Helm release to the specified revision -2. Restore the previous version's configuration -3. Restart Radius components with the previous version - -## Step 3: Verify the rollback - -After the rollback completes, verify that Radius is running the previous version: - -```bash -# Check Radius version -rad version - -# Verify pods are running -kubectl get pods -n radius-system - -# Check Helm release status -helm status radius -n radius-system - -# Verify your environments are still available -rad env list -``` - -## Important considerations - -### CRD compatibility - -> **Warning:** Custom Resource Definitions (CRDs) are not automatically rolled back due to [Helm limitations](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/). -> -> If the newer version introduced CRD changes, rolling back the control plane might result in compatibility issues. In such cases, you may need to: -> -> 1. Manually revert CRD changes, or -> 2. Perform a fresh installation of the desired version - -### Data and configuration - -- **Environments and applications**: These are preserved during rollback as they are stored as Kubernetes resources -- **Custom Helm values**: Previous configuration values are restored with the rollback -- **Workspace configuration**: Local workspace configuration (in ~/.rad) is not affected by rollback - -### When rollback might not work - -Rollback may not be successful if: - -- The previous version's state is corrupted -- There are incompatible CRD changes between versions -- Required dependencies are no longer available -- Breaking changes in the data format between versions - -In these cases, a fresh installation may be required. - -## Alternative: Fresh installation - -If rollback is not possible or encounters issues, you can perform a fresh installation: - -1. Backup your environment configurations: - - ```bash - rad env show -o json > env-backup.json - ``` - -2. Uninstall Radius completely: - - ```bash - rad uninstall kubernetes - ``` - -3. Install the desired version: - - ```bash - # Install a specific version using a local chart - rad install kubernetes --chart /path/to/radius-chart- - - # Or use Helm directly to install a specific version - helm install radius oci://ghcr.io/radius-project/helm-chart --version -n radius-system --create-namespace - ``` - -4. Create new environments and deploy your applications using the backup as reference - -## Troubleshooting - -### Failed rollback - -If the rollback fails, check the Helm rollback status: - -```bash -# Check Helm release status -helm status radius -n radius-system - -# View detailed history -helm history radius -n radius-system - -# Check pod status -kubectl get pods -n radius-system -kubectl describe pods -n radius-system -``` - -### Manual Helm rollback - -If the rad CLI rollback fails, you can use Helm directly: - -```bash -# Rollback using Helm -helm rollback radius [REVISION] -n radius-system - -# Example: rollback to revision 2 -helm rollback radius 2 -n radius-system -``` - -## Next steps - -- Learn about [upgrading Radius]({{< ref "guides/operations/kubernetes/kubernetes-upgrade" >}}) -- Review [Radius versioning]({{< ref "guides/operations/versioning" >}}) for version compatibility -- Check [release notes](https://github.com/radius-project/radius/releases) for version-specific information -- Refer to the [`rad rollback kubernetes`]({{< ref "reference/cli/rad_rollback_kubernetes" >}}) CLI reference docs for more details diff --git a/docs/content/guides/operations/kubernetes/kubernetes-uninstall/index.md b/docs/content/guides/operations/kubernetes/kubernetes-uninstall/index.md deleted file mode 100644 index de50faeb6..000000000 --- a/docs/content/guides/operations/kubernetes/kubernetes-uninstall/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -type: docs -title: "How-To: Uninstall Radius from Kubernetes" -linkTitle: "Uninstall Radius" -description: "Learn how to uninstall Radius control plane from your Kubernetes cluster" -weight: 400 -categories: "How-To" -tags: ["Kubernetes"] ---- - -## Prerequisites - -- [Radius installed on Kubernetes cluster]({{< ref "guides/operations/kubernetes/kubernetes-install" >}}) - -## Step 1: Uninstall the Radius control-plane from your kubernetes cluster - -To uninstall the existing Radius control-plane, run the following command: - -```bash -rad uninstall kubernetes -``` - -All the Radius services running in the `radius-system` namespace will be removed. Note that Radius configuration and data will still be persisted in the cluster until the namespace is also deleted. - -## Step 2: Delete the `radius-system` namespace - -To delete the `radius-system` namespace, run the following command: - -```bash -kubectl delete namespace radius-system -``` - -All Radius configuration and data will be removed as part of the namespace. This completely removes from your cluster. - -## Step 3: Remove the rad CLI - -You can remove the rad CLI by deleting the [ binary ]({{< ref "/guides/tooling/rad-cli/overview#binary-location" >}}) and ~/.rad folder from your machine. \ No newline at end of file diff --git a/docs/content/guides/operations/kubernetes/kubernetes-upgrade/index.md b/docs/content/guides/operations/kubernetes/kubernetes-upgrade/index.md deleted file mode 100644 index f68837244..000000000 --- a/docs/content/guides/operations/kubernetes/kubernetes-upgrade/index.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -type: docs -title: "How-To: Upgrade Radius on Kubernetes" -linkTitle: "Upgrade Radius on Kubernetes" -description: "Learn how to upgrade Radius on Kubernetes" -weight: 300 -categories: "How-To" -tags: ["Kubernetes"] ---- - -Radius supports in-place upgrades on Kubernetes clusters using the `rad upgrade kubernetes` command. This command upgrades the Radius control plane while preserving your existing environments and applications. - -## Prerequisites - -- [Radius installed on Kubernetes cluster]({{< ref "guides/operations/kubernetes/kubernetes-install" >}}) -- [Latest rad CLI]({{< ref howto-rad-cli >}}) - -## Step 1: Upgrade the rad CLI - -First, ensure you have the latest version of the rad CLI: - -{{< read file= "/shared-content/installation/rad-cli/install-rad-cli.md" >}} - -## Step 2: Upgrade Radius control plane - -Use the [`rad upgrade kubernetes` command]({{< ref rad_upgrade_kubernetes >}}) to upgrade Radius in your cluster: - -```bash -# Upgrade to the latest version matching your CLI -rad upgrade kubernetes - -# Upgrade to a specific version -rad upgrade kubernetes --version 0.49.0 - -# Upgrade with custom configuration -rad upgrade kubernetes --set key=value -``` - -### Preflight checks - -The upgrade process automatically runs preflight checks to ensure your cluster is ready for the upgrade. These checks include: - -- **Kubernetes connectivity and permissions**: Verifies connection to the cluster and required RBAC permissions -- **Helm connectivity and installation status**: Confirms Radius is installed via Helm and can be upgraded -- **Version compatibility validation**: Ensures the target version is compatible with your current version -- **Cluster resource availability**: Checks for sufficient resources (optional warning) -- **Custom configuration validation**: Validates any custom Helm values - -To skip preflight checks (not recommended): - -```bash -rad upgrade kubernetes --skip-preflight -``` - -To run only preflight checks without upgrading: - -```bash -rad upgrade kubernetes --preflight-only -``` - -## Step 3: Verify the upgrade - -After the upgrade completes, verify that Radius is running the new version: - -```bash -# Check Radius version -rad version - -# Verify pods are running -kubectl get pods -n radius-system - -# Check your environments are still available -rad env list -``` - -## Important considerations - -### Breaking changes - -While Radius supports in-place upgrades, breaking changes may still occur between major versions. Always review the [release notes](https://github.com/radius-project/radius/releases) before upgrading to understand any breaking changes or migration steps required. - -### Rollback capability - -If an upgrade encounters issues, you can rollback to a previous version using the [`rad rollback kubernetes` command]({{< ref "guides/operations/kubernetes/kubernetes-rollback" >}}). - -It's recommended to backup your environment configurations before upgrading, which you may do with something like `rad env show -o json > env-backup.json`. - -## Alternative: Fresh installation - -If you prefer to do a fresh installation instead of an in-place upgrade, follow these steps: - -1. Delete all existing Radius Environments: - - ```bash - # List all environments - rad env list - - # Delete each environment - rad env delete - ``` - -2. Uninstall Radius: - - ```bash - rad uninstall kubernetes - ``` - -3. Install the latest version: - - ```bash - rad install kubernetes - ``` - -4. Create new environments and deploy your applications - -## Next steps - -- Learn how to [rollback Radius]({{< ref "guides/operations/kubernetes/kubernetes-rollback" >}}) if needed -- Review [Radius versioning]({{< ref "guides/operations/versioning" >}}) for version compatibility information -- Refer to the [`rad upgrade`]({{< ref "reference/cli/rad_upgrade_kubernetes" >}}) CLI reference docs for more details diff --git a/docs/content/guides/operations/kubernetes/overview/index.md b/docs/content/guides/operations/kubernetes/overview/index.md deleted file mode 100644 index 03e48d978..000000000 --- a/docs/content/guides/operations/kubernetes/overview/index.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -type: docs -title: "Overview: Radius on Kubernetes platform" -linkTitle: "Overview" -description: "Learn how Radius can run on Kubernetes" -weight: 100 -categories: ["Overview"] -tags: ["Kubernetes"] ---- - -Radius offers a Kubernetes-based platform for hosting the [Radius control plane]({{< ref "/guides/operations/control-plane" >}}) and [Radius Environments]({{< ref "concepts/environments" >}}). - -{{< image src="kubernetes-mapping.png" alt="Diagram showing Radius resources being mapped to Kubernetes objects" width=600px >}} - -## Supported Kubernetes versions - -Kubernetes version `1.23.8` or higher is recommended to run Radius. - -## Resource mapping - -Radius resources, when deployed to a Kubernetes environment, are mapped to one or more Kubernetes objects. The following table describes the mapping between Radius resources and Kubernetes objects: - -| Radius resource/configuration | Kubernetes object | -|----------------------------------|-------------------| -| [`Applications.Core/containers`]({{< ref container-schema >}}) | `apps/Deployment@v1`

`core/Service@v1` _(if ports defined)_ | -| `Applications.Core/containers` connections | `core/Secret@v1`
Mounted to the container as environment variables. Refer to the [connections guide]({{< ref howto-connect-dependencies >}}) to learn more. | -| [`Applications.Core/gateways`]({{< ref gateway >}}) | `projectcontour.io/HTTPProxy@v1` | -| [`Applications.Dapr/pubSubBrokers`]({{< ref dapr-pubsub >}}) | `dapr.io/Component@v1alpha1` | -| [`Applications.Dapr/secretStores`]({{< ref dapr-secretstore >}}) | `dapr.io/Component@v1alpha1` | -| [`Applications.Dapr/stateStores`]({{< ref dapr-statestore >}}) | `dapr.io/Component@v1alpha1` | - -### Namespace mapping - -Application-scoped resources are by default generated in a new Kubernetes namespace with the name format `'-'`. This prevents multiple applications with resources of the same name from conflicting with each other. - -For example, let's take an application named `'myapp'` with a container named `'frontend'`. This application is deployed into an environment configured with the `'default'` namespace. A Kubernetes Deployment named `'frontend'` is now deployed into the namespace `'default-myapp'`. - -If you wish to override the default behavior and specify your own namespace for application resources to be generated into, you can leverage the [`kubernetesNamespace` application extension]({{< ref "application-schema#kubernetesNamespace" >}}). All application-scoped resources will now be deployed into this namespace instead. - -### Resource naming - -Resources that are generated in Kubernetes use the same name as the resource in Radius. For example, a Radius container named 'frontend' will map to a Kubernetes Deployment named `'frontend'`. This makes it easy to conceptually map between Radius and Kubernetes resources. - -For multiple Radius resources that map to a single Kubernetes resource (_e.g. daprPubSubBrokers, daprSecretStores, and daprStateStores all map to a dapr.io/Component_) and there are collisions in naming, Radius has conflict logic to allow the first resource to be deployed but will throw a warning for subsequent resource deployments that have the same name. This prevents Radius resources from unintentionally overwriting the same generated resource. - -## Kubernetes metadata - -Radius Environments, applications, and resources can be annotated/labeled with Kubernetes metadata. Refer to the Kubernetes metadata page for more information: - -{{< button text="Kubernetes metadata" page="kubernetes-metadata" >}} - -## Supported Kubernetes clusters - -The following clusters have been tested and validated to ensure they support all of the features of Radius: - -{{< tabs AKS k3d kind EKS >}} - -{{% codetab %}} -Azure Kubernetes Service (AKS) clusters are the easiest way to get up and running quickly with a Radius Environment. To learn how to setup a cluster visit the [Azure docs](https://docs.microsoft.com/azure/aks/learn/quick-kubernetes-deploy-portal?tabs=azure-cli). - -Note that [AKS-managed AAD](https://docs.microsoft.com/en-us/azure/aks/managed-aad) is not supported currently. - -To create a new AKS cluster and retrieve its kubecontext, you can run the following commands: - -```bash -az aks create --subscription mySubscription --resource-group myResourceGroup --name myAKSCluster --node-count 1 -az aks get-credentials --subscription mySubscription --resource-group myResourceGroup --name myAKSCluster -``` - -Once deployed and your kubectl context has been set as your default, you can run the following to create a Radius Environment and install the control plane: - -```bash -rad init -``` -{{% /codetab %}} - -{{% codetab %}} -[k3d](https://k3d.io) is a lightweight wrapper to run [k3s](https://github.com/rancher/k3s) (Rancher Lab’s minimal Kubernetes distribution) in Docker. - -First, ensure that memory resource is 8GB or more in `Resource` setting of `Preferences` if you're using Docker Desktop. Also make sure you've enabled Rosetta if you're running on an Apple M1 chip: - -```bash -softwareupdate --install-rosetta --agree-to-license -``` - -Use the following command to create a new cluster. and install the Radius control plane, along with a new environment: - -- The first parameter adds a port mapping which routes traffic from the local machine into the cluster. -- The second parameter disables [`traefik`](https://k3d.io/v5.1.0/usage/k3s/#traefik) pods because Radius provides an ingress controller. -- The third parameter disables the [k3d internal load balancer](https://k3d.io/v5.1.0/usage/k3s/#servicelb-klipper-lb). - -The `rad install` command is configured to route localhost traffic on port 8081 into the cluster. - -```bash -k3d cluster create -p "8081:80@loadbalancer" --k3s-arg "--disable=traefik@server:*" --k3s-arg "--disable=servicelb@server:*" -``` - -Next, install the Radius control plane, along with a new environment. The `rad install` command below adds a parameter to override the default public endpoint so that Radius knows that traffic from the local machine will enter the pod on port 8081: - -```bash -rad install kubernetes --set rp.publicEndpointOverride=localhost:8081 -rad init -``` -{{% /codetab %}} - -{{% codetab %}} -[Kind](https://kind.sigs.k8s.io/) is a tool for running local Kubernetes clusters inside Docker containers. Use the following setup to create a new cluster and install the Radius control plane, along with a new environment: - -First, ensure that memory resource is 8GB or more in `Resource` setting of `Preferences` if you're using Docker Desktop. Also make sure you've enabled Rosetta if you're running on an Apple M1 chip: - -```bash -softwareupdate --install-rosetta --agree-to-license -``` - -Second, copy the text below into a new file `kind-config.yaml`: - -```yaml -kind: Cluster -apiVersion: kind.x-k8s.io/v1alpha4 -nodes: -- role: control-plane -- role: worker - extraPortMappings: - - containerPort: 80 - hostPort: 8080 - listenAddress: "0.0.0.0" - - containerPort: 443 - hostPort: 8443 - listenAddress: "0.0.0.0" -``` - -Then, create a kind cluster with this config and initialize your Radius 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 -``` -{{% /codetab %}} - -{{% codetab %}} -Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that you can use to run Kubernetes on AWS. Learn how to set up an EKS cluster on the [AWS docs](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html). - -```bash -eksctl create cluster --name my-cluster --region region-code -``` - -Once deployed and your kubectl context has been set as your default, you can run the following to create a Radius Environment and install the control plane: - -```bash -rad init -``` - -{{% /codetab %}} - -{{< /tabs >}} - -## Configure container registry access - -If you choose a private container registry you will need to take steps to configure your Kubernetes cluster to allow access. Follow the instructions provided by your cloud provider. - -{{< tabs "Generic" "AKS + ACR" >}} - -{{% codetab %}} -Visit the [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) to learn how to configure your cluster to access a private registry, such as Docker Hub. -{{% /codetab %}} - -{{% codetab %}} -Visit the [Azure docs](https://docs.microsoft.com/azure/aks/cluster-container-registry-integration?tabs=azure-cli)to learn how to configure access to an ACR registry. - -```bash -az aks update --name myAKSCluster --resource-group myResourceGroup --subscription mySubscription --attach-acr -``` - -{{% /codetab %}} - -{{< /tabs >}} diff --git a/docs/content/guides/operations/kubernetes/overview/kubernetes-mapping.png b/docs/content/guides/operations/kubernetes/overview/kubernetes-mapping.png deleted file mode 100644 index 7d0a185b2..000000000 Binary files a/docs/content/guides/operations/kubernetes/overview/kubernetes-mapping.png and /dev/null differ diff --git a/docs/content/guides/operations/providers/_index.md b/docs/content/guides/operations/providers/_index.md deleted file mode 100644 index 4596372b2..000000000 --- a/docs/content/guides/operations/providers/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Cloud providers" -linkTitle: "Cloud providers" -description: "Deploy across clouds and platforms with Radius cloud providers" -weight: 300 ---- diff --git a/docs/content/guides/operations/providers/aws-provider/_index.md b/docs/content/guides/operations/providers/aws-provider/_index.md deleted file mode 100644 index f2cff4861..000000000 --- a/docs/content/guides/operations/providers/aws-provider/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "AWS provider" -linkTitle: "AWS provider" -description: "Deploy and connect to AWS resources" -weight: 300 ---- \ No newline at end of file diff --git a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-access-key/index.md b/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-access-key/index.md deleted file mode 100644 index 049ee14a4..000000000 --- a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-access-key/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -type: docs -title: "How-To: Configure the AWS cloud provider with IAM Access key" -linkTitle: "AWS provider with IAM Access key" -description: "Learn how to configure the AWS provider with IAM Access key for your Radius Environment" -weight: 100 -categories: "How-To" -tags: ["AWS"] ---- - -The AWS provider allows you to deploy and connect to AWS resources from a Radius Environment on an EKS cluster. It can be configured: - -- [Interactively via `rad init`](#interactive-configuration) -- [Manually via `rad env update` and `rad credential register`](#manual-configuration) - -## Prerequisites - -- [AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account) and an [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) -- [Setup AWS CLI with your AWS credentials. ](https://docs.aws.amazon.com/cli/latest/reference/configure/) -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) - -## Interactive configuration - -1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): - - ```bash - rad init --full - ``` - -1. Follow the prompts, specifying: - - **Namespace** - The Kubernetes namespace where your application containers and networking resources will be deployed (different than the Radius control-plane namespace, `radius-system`). - - **Add an AWS provider** - 1. Select the "Access Key" option - 2. Enter IAM access key and secret key. - 3. Confirm the AWS account ID or provide the account ID you would like to use. - 4. Select a region to deploy your AWS resources to. - - **Environment name** - The name of the environment to create. - - You should see the following output: - - ``` - Initializing Radius... - - βœ… Install Radius {{< param version >}} - - Kubernetes cluster: k3d-k3s-default - - Kubernetes namespace: radius-system - - AWS IAM access key ID: **** - βœ… Create new environment default - - Kubernetes namespace: default - - AWS: account ***** and region: us-west-2 - βœ… Scaffold application samples - βœ… Update local configuration - - Initialization complete! Have a RAD time 😎 - ``` - -## Manual configuration - -1. Update your Radius Environment with your AWS region and AWS account ID: - - ```bash - rad env update myEnvironment --aws-region myAwsRegion --aws-account-id myAwsAccountId - ``` - - This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad env update`]({{< ref rad_environment_update >}}) - -1. Add your AWS cloud provider credentials: - - ```bash - rad credential register aws access-key --access-key-id myAccessKeyId --secret-access-key mySecretAccessKey - ``` - - For more information on the command arguments visit [`rad credential register aws access-key`]({{< ref rad_credential_register_aws_access-key >}}) diff --git a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/index.md b/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/index.md deleted file mode 100644 index 8e0728616..000000000 --- a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/index.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -type: docs -title: "How-To: Configure the AWS cloud provider with IAM Roles for Service Accounts (IRSA)" -linkTitle: "AWS provider with IRSA" -description: "Learn how to configure the AWS provider with IAM Roles for Service Accounts(IRSA) for your Radius Environment" -weight: 200 -categories: "How-To" -tags: ["AWS"] ---- - -The AWS provider allows you to deploy and connect to AWS resources from a Radius Environment on an EKS cluster. It can be configured: - -- [Interactively via `rad init`](#interactive-configuration) -- [Manually via `rad env update` and `rad credential register`](#manual-configuration) - -## Prerequisites - -- [AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account) and an [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html) -- [Setup AWS CLI with your AWS credentials. ](https://docs.aws.amazon.com/cli/latest/reference/configure/) -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) - - You will need the cluster's OIDC Issuer URL. [EKS Example](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) -- [Create an IAM Policy](https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) - - -## Setup the AWS IAM Roles for Service Accounts(IRSA) for Radius - -To authorize Radius to connect to AWS using AWS IAM Roles for Service Accounts(IRSA), you should assign IAM roles to Kubernetes service accounts. To associate an IAM role with a Kubernetes service account Create an IAM role and associate it with a Kubernetes service account. - -- Go to Identity and Access Management (IAM) on AWS portal and create a new role. - -{{< image src="create-role.png" width=700px alt="Screenshot of Create Role page in AWS portal" >}} -
-- Select `Trusted entity type` as `Web Identity` and `Identity Provider` as the cluster OIDC url. - - {{< image src="select-trust-entity.png" width=700px alt="Screenshot of options to pass while selecting trust entity." >}} - -- Select the created IAM policy to attach to your new role. -- Add `Role Name` and create role using the default trust policy. -- Update the Trust Policy to match to the below format. - ``` - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Federated": "arn:aws:iam:::oidc-provider/" - }, - "Action": "sts:AssumeRoleWithWebIdentity", - "Condition": { - "StringEquals": { - ":aud": "sts.amazonaws.com", - ":sub": "system:serviceaccount:radius-system:ucp" - } - } - }, - { - "Sid": "Statement1", - "Effect": "Allow", - "Principal": { - "Federated": "arn:aws:iam:::oidc-provider/" - }, - "Action": "sts:AssumeRoleWithWebIdentity", - "Condition": { - "StringEquals": { - ":aud": "sts.amazonaws.com", - ":sub": "system:serviceaccount:radius-system:applications-rp" - } - } - } - ] - } - ``` -Now that the setup is complete, you can install Radius with AWS IRSA enabled. - -## Interactive configuration - -1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): - - ```bash - rad init --full - ``` - -1. Follow the prompts, specifying: - - **Namespace** - The Kubernetes namespace where your application containers and networking resources will be deployed (different than the Radius control-plane namespace, `radius-system`) - - **Add an AWS provider** - 1. Select the "IRSA" option - 2. Enter IAM Role ARN.Find the ARN from the role created in the setup step. - - {{< image src="get-role-arn.png" width=700px alt="Screenshot of role details to get role ARN." >}} - - 3. Confirm the AWS account ID or provide the account ID you would like to use. - 4. Select a region to deploy your AWS resources to. - - **Environment name** - The name of the environment to create - - You should see the following output: - - ``` - Initializing Radius. This may take a minute or two... - - βœ… Install Radius {{< param version >}} - - Kubernetes cluster: k3d-k3s-default - - Kubernetes namespace: radius-system - - AWS credential: IRSA - - IAM Role ARN: arn:aws:iam::myAccountID:role/radius-role-new - βœ… Create new environment default - - Kubernetes namespace: default - - AWS: account myAccountID and region us-east-2 - βœ… Update local configuration - - Initialization complete! Have a RAD time 😎 - ``` - -## Manual configuration - -1. Use [`rad install kubernetes`]({{< ref rad_install_kubernetes >}}) to install Radius with AWS AWS IAM Roles for Service Accounts(IRSA) enabled: - - ```bash - rad install kubernetes --set global.aws.irsa.enabled=true - ``` - -1. Create your resource group and environment: - - ```bash - rad group create default - rad env create default - ``` - -1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your your AWS region and AWS account ID: - - ```bash - rad env update myEnvironment --aws-region myAwsRegion --aws-account-id myAwsAccountId - ``` - -1. Use [`rad credential register aws irsa`]({{< ref rad_credential_register_aws_irsa >}}) to add the AWS IRSA credentials: - - ```bash - rad credential register aws irsa --iam-role myRoleARN - ``` - - Radius will use the provided roleARN for all interactions with AWS, including Bicep and Recipe deployments. diff --git a/docs/content/guides/operations/providers/azure-provider/_index.md b/docs/content/guides/operations/providers/azure-provider/_index.md deleted file mode 100644 index 736c13205..000000000 --- a/docs/content/guides/operations/providers/azure-provider/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Azure provider" -linkTitle: "Azure providers" -description: "Deploy and connect to Azure resources" -weight: 200 ---- \ No newline at end of file diff --git a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-sp/index.md b/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-sp/index.md deleted file mode 100644 index 3ac171c7c..000000000 --- a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-sp/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -type: docs -title: "How-To: Configure the Azure cloud provider with Service Principal" -linkTitle: "Azure provider with Service Principal" -description: "Learn how to configure the Azure provider with Service Principal for your Radius Environment" -weight: 100 -categories: "How-To" -tags: ["Azure"] ---- - -The Azure provider allows you to deploy and connect to Azure resources from a self-hosted Radius Environment. It can be configured: - -- [Prerequisites](#prerequisites) -- [Interactive configuration](#interactive-configuration) -- [Manual configuration](#manual-configuration) - -## Prerequisites - -- [Azure subscription](https://azure.com) -- [az CLI](https://aka.ms/azcli) -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) - -## Interactive configuration - -1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): - - ```bash - rad init --full - ``` - -1. Follow the prompts, specifying: - - **Namespace** - The Kubernetes namespace where your application containers and networking resources will be deployed (different than the Radius control-plane namespace, `radius-system`) - - **Add an Azure provider** - 1. Pick the subscription and resource group to deploy your Azure resources to. The resource group should exist. - 2. Select the "Service Principal" option. - 3. Run `az ad sp create-for-rbac` to create a Service Principal without a role assignment and obtain your `appId`, `displayName`, `password`, and `tenant` information. - - ``` - { - "appId": "****", - "displayName": "****", - "password": "****", - "tenant": "****" - } - ``` - Enter the `appId`, `password`, and `tenant` information when prompted. - 4. Grant the service principal access to the resource group using the Azure role that allows creating the resource you plan to deploy. - - - **Environment name** - The name of the environment to create - - You should see the following output: - - ``` - Initializing Radius... - - βœ… Install Radius {{< param version >}} - - Kubernetes cluster: k3d-k3s-default - - Kubernetes namespace: radius-system - - Azure service principal: **** - βœ… Create new environment default - - Kubernetes namespace: default - - Azure: subscription ***** and resource group *** - βœ… Scaffold application samples - βœ… Update local configuration - - Initialization complete! Have a RAD time 😎 - ``` - -## Manual configuration - -1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group. The resource group should exist: - - ```bash - rad env update myEnvironment --azure-subscription-id myAzureSubscriptionId --azure-resource-group myAzureResourceGroup - ``` - -2. Run `az ad sp create-for-rbac` to create a Service Principal without a role assignment and obtain your `appId`, `displayName`, `password`, and `tenant` information. - - ``` - { - "appId": "****", - "displayName": "****", - "password": "****", - "tenant": "****" - } - ``` - -3. Grant the service principal access to the resource group using the Azure role that allows creating the resource you plan to deploy. - -4. Use [`rad credential register azure`]({{< ref rad_credential_register_azure >}}) to add the Azure service principal to your Radius installation: - - ```bash - rad credential register azure sp --client-id myClientId --client-secret myClientSecret --tenant-id myTenantId - ``` - - Radius will use the provided service principal for all interactions with Azure, including Bicep and Recipe deployments. diff --git a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/index.md b/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/index.md deleted file mode 100644 index fc2bd7415..000000000 --- a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -type: docs -title: "How-To: Configure the Azure cloud provider with Azure workload identity" -linkTitle: "Azure provider with Workload identity" -description: "Learn how to configure the Azure provider with Azure workload identity for your Radius Environment" -weight: 200 -categories: "How-To" -tags: ["Azure"] ---- - -The Azure provider allows you to deploy and connect to Azure resources from a self-hosted Radius Environment. It can be configured: - -- [Interactively via `rad init`](#interactive-configuration) -- [Manually via `rad env update` and `rad credential register`](#manual-configuration) - -## Prerequisites - -- [Azure subscription](https://azure.com) -- [az CLI](https://aka.ms/azcli) -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) - - You will need the cluster's OIDC Issuer URL. [AKS Example](https://azure.github.io/azure-workload-identity/docs/installation/managed-clusters.html#azure-kubernetes-service-aks) -- [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) - -## Setup the Azure Workload Identity for Radius - -To authorize Radius to connect to Azure using Azure workload identity, you should set up an Entra ID Application with access to your resource group and 3 federated credentials (one for each of the Radius services). The 3 federated credentials should be created with the Kubernetes ServiceAccounts for each of the Radius services (applications-rp, bicep-de, and ucp) in the `radius-system` namespace and the OIDC Issuer for your Kubernetes cluster. - -Below is an example script that will create an Entra ID Application and set up the federated credentials necessary for Radius to authenticate with Azure using Azure workload identity. - -{{< rad file="snippets/install-radius-azwi.sh" embed=true lang=bash >}} - -Now that the setup is complete, you can now install Radius with Azure workload identity enabled. - -## Interactive configuration - -1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): - - ```bash - rad init --full - ``` - -1. Follow the prompts, specifying: - - **Namespace** - The Kubernetes namespace where your application containers and networking resources will be deployed (different than the Radius control-plane namespace, `radius-system`) - - **Add an Azure provider** - 1. Pick the subscription and resource group to deploy your Azure resources to. - 2. Select the "Workload Identity" option - 3. Enter the `appId` and the `tenantID` of the Entra ID Application - - **Environment name** - The name of the environment to create - - You should see the following output: - - ``` - Initializing Radius... - - βœ… Install Radius {{< param version >}} - - Kubernetes cluster: k3d-k3s-default - - Kubernetes namespace: radius-system - - Azure credential: WorkloadIdentity - - Client ID: ********** - βœ… Create new environment default - - Kubernetes namespace: default - - Azure: subscription ***** and resource group *** - βœ… Scaffold application samples - βœ… Update local configuration - - Initialization complete! Have a RAD time 😎 - ``` - -## Manual configuration - -1. Use [`rad install kubernetes`]({{< ref rad_install_kubernetes >}}) to install Radius with Azure workload identity enabled: - - ```bash - rad install kubernetes --set global.azureWorkloadIdentity.enabled=true - ``` - -1. Create your resource group and environment: - - ```bash - rad group create default - rad env create default - ``` - -1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group: - - ```bash - rad env update myEnvironment --azure-subscription-id myAzureSubscriptionId --azure-resource-group myAzureResourceGroup - ``` - -1. Use [`rad credential register azure wi`]({{< ref rad_credential_register_azure_wi >}}) to add the Azure workload identity credentials: - - ```bash - rad credential register azure wi --client-id myClientId --tenant-id myTenantId - ``` - - Radius will use the provided client-id for all interactions with Azure, including Bicep and Recipe deployments. diff --git a/docs/content/guides/operations/providers/overview/index.md b/docs/content/guides/operations/providers/overview/index.md deleted file mode 100644 index a0cdf0f9a..000000000 --- a/docs/content/guides/operations/providers/overview/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -type: docs -title: "Overview: Cloud providers" -linkTitle: "Overview" -description: "Deploy across clouds and platforms with Radius cloud providers" -weight: 100 -categories: "Overview" -tags: ["AWS","Azure"] ---- - -Radius cloud providers allow you to deploy and connect to cloud resources across various cloud platforms. For example, you can use the Radius Azure provider to run your application's services in your Kubernetes cluster, while deploying Azure resources to a specified Azure subscription and resource group. - -{{< image src="providers-overview.png" alt="Diagram of cloud resources getting forwarded to cloud platforms upon deployment" width="800px" >}} - -## Supported cloud providers and identities - -| Provider | Identity | Description | -|----------|----------|-------------| -| [Microsoft Azure]({{< ref azure-provider >}}) | [Service Principal](https://learn.microsoft.com/en-us/entra/identity-platform/app-objects-and-service-principals?tabs=browser) | Deploy and connect to Azure resources using Service Principal | -| | [Workload Identity](https://learn.microsoft.com/en-us/entra/workload-id/workload-identities-overview) | Deploy and connect to Azure resources using Workload Identity | -| [Amazon Web Services]({{< ref aws-provider >}}) | [IAM access Key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) | Deploy and connect to AWS resources using IAM Access Key | -| | [IAM Roles for Service Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) | Deploy and connect to AWS resources using AWS IRSA | diff --git a/docs/content/guides/operations/providers/overview/provider.svg b/docs/content/guides/operations/providers/overview/provider.svg deleted file mode 100644 index df1d73b08..000000000 --- a/docs/content/guides/operations/providers/overview/provider.svg +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/content/guides/operations/providers/overview/providers-overview.png b/docs/content/guides/operations/providers/overview/providers-overview.png deleted file mode 100644 index c8a7a6b60..000000000 Binary files a/docs/content/guides/operations/providers/overview/providers-overview.png and /dev/null differ diff --git a/docs/content/guides/operations/versioning.md b/docs/content/guides/operations/versioning.md deleted file mode 100644 index 32f6255b4..000000000 --- a/docs/content/guides/operations/versioning.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -type: docs -title: "Overview: Radius versioning policy" -linkTitle: "Versioning" -description: "Radius versioning policy" -weight: 600 -category: "Overview" ---- - -## Overview - -Radius does not currently offer backward compatibility with previous releases. Breaking changes may happen between releases and we recommend doing a fresh installation of the latest version of Radius after every release. - -We are working on the versioning strategy and will be introducing a versioning policy in the future. diff --git a/docs/content/guides/operations/workspaces/_index.md b/docs/content/guides/operations/workspaces/_index.md deleted file mode 100644 index 070840a61..000000000 --- a/docs/content/guides/operations/workspaces/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -type: docs -title: "Overview: Radius workspaces" -linkTitle: "Workspaces" -description: "Learn how to handle multiple Radius platforms and environments with workspaces" -weight: 250 -categories: "Overview" ---- \ No newline at end of file diff --git a/docs/content/guides/operations/workspaces/howto-workspaces/index.md b/docs/content/guides/operations/workspaces/howto-workspaces/index.md deleted file mode 100644 index 6640b511b..000000000 --- a/docs/content/guides/operations/workspaces/howto-workspaces/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -type: docs -title: "How-To: Use Radius workspaces" -linkTitle: "Use Workspaces" -description: "Learn how to handle multiple Radius platforms and environments with workspaces" -weight: 300 -categories: "How-To" ---- - -## Pre-requisites - -- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) - -## How-to: Use workspaces to switch between environments - -When you have multiple environments initialized for different purposes workspaces enable you to switch between different environments easily. You can create separate workspaces and switch between them as you are working through your deployment lifecycle. - -1. Install the Radius control plane on kubernetes cluster - - ```sh - rad install kubernetes - ``` - -1. Create a resource group named `mygroup` using [`rad group create`]({{< ref rad_group_create >}}): - - ```sh - rad group create mygroup - ``` - -1. Create an environment named `myenvironment` using [`rad env create`]({{< ref rad_environment_create >}}): - - ```sh - rad env create myenvironment - ``` - -1. Create a workspace named `myworkspace` using [`rad workspace create`]({{< ref rad_workspace_create >}}): - - ```sh - rad workspace create kubernetes myworkspace --group mygroup --environment myenvironment - ``` - - Radius writes the workspace details to your local configuration file (`~/.rad/config.yaml` on Linux and macOS, `%USERPROFILE%\.rad\config.yaml` on Windows). -1. Create another resource group named `yourgroup` using [`rad group create`]({{< ref rad_group_create >}}): - - ```sh - rad group create yourgroup - ``` - -1. Create an environment named `yourenvironment` using [`rad env create`]({{< ref rad_environment_create >}}): - - ```sh - rad env create yourenvironment - ``` - -1. Create a workspace named `yourworkspace` using [`rad workspace create`]({{< ref rad_workspace_create >}}): - - ```sh - rad workspace create kubernetes yourworkspace --group yourgroup --environment yourenvironment - ``` - -1. Verify your `config.yaml` file. It should show both `myworkspace` and `yourworkspace` workspaces, with your environments: - - ```yaml - workspaces: - default: yourworkspace - items: - yourworkspace: - connection: - context: mycluster - kind: kubernetes - environment: /planes/radius/local/resourcegroups/yourgroup - /providers/applications.core/environments/yourenvironment - scope: /planes/radius/local/resourceGroups/yourgroup - myworkspace: - connection: - context: mycluster - kind: kubernetes - environment: /planes/radius/local/resourcegroups/mygroup - /providers/applications.core/environments/myenvironment - scope: /planes/radius/local/resourceGroups/mygroup - ``` - -1. You can now deploy applications to both myworkspace and yourworkspace using [`rad deploy`]({{< ref rad_deploy >}}), specifying the `-w` flag. diff --git a/docs/content/guides/operations/workspaces/overview/index.md b/docs/content/guides/operations/workspaces/overview/index.md deleted file mode 100644 index fc0117788..000000000 --- a/docs/content/guides/operations/workspaces/overview/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -type: docs -title: "Overview: Radius workspaces" -linkTitle: "Overview" -description: "Learn how to handle multiple Radius platforms and environments with workspaces" -weight: 200 -categories: "Overview" ---- - -## What are workspaces? - -Workspaces allow you to manage multiple Radius [environments]({{< ref "concepts/environments" >}}) using a local, client-side, configuration file. You can easily define and switch between workspaces to deploy and manage applications across separate environments. - -{{< image src=workspaces.png alt="Diagram showing a Radius configuration file mapping workspaces to Kubernetes clusters" width=800px >}} - -The [`config.yaml`]({{< ref "/reference/config" >}}) file in your local Radius directory contains workspace entries that point to a Radius platform and environment. - -## CLI commands - -The following commands let you interact with Radius Environments: - -{{< tabs create list show delete switch >}} - -{{% codetab %}} -[rad workspace create kubernetes]({{< ref rad_workspace_create >}}) creates a new workspace: - -```bash -rad workspace create kubernetes -``` - -{{% /codetab %}} - -{{% codetab %}} -[rad workspace list]({{< ref rad_workspace_list >}}) lists all of the workspaces in your configuration file: - -```bash -rad workspace list -``` - -{{% /codetab %}} - -{{% codetab %}} -[rad workspace show]({{< ref rad_workspace_show >}}) prints information on the default or specified workspace: - -```bash -rad workspace show -``` - -{{% /codetab %}} - -{{% codetab %}} -[rad workspace delete]({{< ref rad_workspace_delete >}}) deletes the specified workspace: - -```bash -rad workspace delete -w myenv -``` - -{{% /codetab %}} - -{{% codetab %}} -[rad workspace switch]({{< ref rad_workspace_switch >}}) switches the default workspace: - -```bash -rad workspace switch -w myworkspace -``` - -{{% /codetab %}} - -{{< /tabs >}} - -## Example - -Your Radius configuration file contains workspace entries that point to a Radius platform and environment: - -```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 -``` - -## Schema - -Visit the [`config.yaml` reference docs]({{< ref config >}}) to learn about workspace definitions. - -{{< button text="config.yaml Schema" page="config" >}} diff --git a/docs/content/guides/operations/workspaces/overview/workspaces.png b/docs/content/guides/operations/workspaces/overview/workspaces.png deleted file mode 100644 index dd88e24de..000000000 Binary files a/docs/content/guides/operations/workspaces/overview/workspaces.png and /dev/null differ diff --git a/docs/content/guides/recipes/_index.md b/docs/content/guides/recipes/_index.md deleted file mode 100644 index cf593bf01..000000000 --- a/docs/content/guides/recipes/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Radius Recipes" -linkTitle: "Recipes" -description: "Learn how to automate infrastructure deployment for your resources with Radius Recipes" -weight: 300 ---- diff --git a/docs/content/guides/recipes/howto-author-recipes/index.md b/docs/content/guides/recipes/howto-author-recipes/index.md deleted file mode 100644 index 47ed65231..000000000 --- a/docs/content/guides/recipes/howto-author-recipes/index.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -type: docs -title: "How-To: Author a Radius Recipe" -linkTitle: "Author a Radius Recipe" -description: "Learn how to author and register a custom Recipe template to automate infrastructure provisioning" -weight: 500 -categories: "How-To" -tags: ["recipes"] ---- - -### Prerequisites - -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" >}}) -- [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/) - -### Step 1: Author a Recipe template - -Begin by creating your Bicep or Terraform template. Ensure that the resource name(s) are **unique** and **repeatable**, so they don't overlap when used by multiple applications. - -> To make naming easy, a [`context` parameter]({{< ref context-schema >}}) is automatically injected into your template. It contains metadata about the backing app/environment which you can use to generate unique and repeatable names. - -{{< tabs "Bicep" "Terraform" >}} - -{{% codetab %}} - -Create `app.bicep` and use the `context` parameter for naming and namespace configuration: - -{{< rad file="snippets/redis-kubernetes.bicep" embed=true marker="//RESOURCE" >}} - -{{% /codetab %}} - -{{% codetab %}} - -Add the `context` parameter to your `variable.tf` file: - -{{< rad file="snippets/redis-kubernetes-variables.tf" embed=true marker="//CONTEXT" lang="terraform" >}} - -Ensure that your `main.tf` has: - -- Defined `required_providers` for any providers you leverage in your module. This allows Radius to inject configuration and credentials. -- Utilizes the `context` parameter for naming and namespace configuration. This ensures your resources don't unintentionally collide with other uses of the Recipe. - -{{< rad file="snippets/redis-kubernetes-main.tf" embed=true lang="terraform" >}} - -{{% /codetab %}} - -{{< /tabs >}} - -### Step 2: Add parameters/variables for Recipe customization (optional) - -You can optionally add parameters/variables to your Recipe to allow developers and/or operators to customize the Recipe for an application/environment. Parameters can be set both when a Recipe is added to an environment by an operator, or by a developer when the Recipe is called. - -{{< tabs "Bicep" "Terraform" >}} - -{{% codetab %}} - -You can create any [parameter type supported by Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/parameters): - -{{< rad file="snippets/redis-kubernetes.bicep" embed=true marker="//PARAMETERS" >}} - -{{% /codetab %}} - -{{% codetab %}} - -You can create any [variable type supported by Terraform](https://developer.hashicorp.com/terraform/language/values/variables): - -{{< rad file="snippets/redis-kubernetes-variables.tf" embed=true marker="//PARAMETERS" lang="terraform" >}} - -{{% /codetab %}} - -{{< /tabs >}} - -### Step 3: Output the result - -Once you have defined your IaC template you will need to output a `result` object with the values, secrets, and resources that the target resource requires. This is how Radius "wires up" the Recipe. - -The `result` object must include: -- **`values`**: The fields that the target resource requires. (_username, host, port, etc._) -- **`secrets`**: The fields that the target resource requires, but should be treated as secrets. (_password, connectionString, etc._) -- **`resources`**: The [UCP ID(s)]({{< ref "resource-ids" >}}) of the resources providing the backing service. Used by UCP to track dependencies and manage deletion. - -{{< tabs "Bicep" "Terraform" >}} - -{{% codetab %}} - -Resources are populated automatically for Bicep Recipes for any new Azure or AWS resource For Kubernetes, make sure to include the UCP ID of any Kubernetes resources your Recipe creates. - -{{< rad file="snippets/redis-kubernetes.bicep" embed=true marker="//OUTPUT" >}} - -{{% /codetab %}} - -{{% codetab %}} - -{{< rad file="snippets/redis-kubernetes-output.tf" embed=true lang="terraform" >}} - -{{% /codetab %}} - -{{< /tabs >}} - -### Step 4: Store your template - -{{< tabs "Bicep" "Terraform" >}} - -{{% codetab %}} - -Recipes leverage [Bicep registries](https://learn.microsoft.com/azure/azure-resource-manager/bicep/private-module-registry) for template storage. Once you've authored a Recipe, you can publish it to your preferred OCI-compliant registry with [`rad bicep publish`]({{< ref rad_bicep_publish >}}): - -```bash -rad bicep publish --file myrecipe.bicep --target br:ghcr.io/USERNAME/recipes/myrecipe:1.1.0 -``` - -{{% /codetab %}} - -{{% codetab %}} - -Follow the [Terraform module publishing docs](https://developer.hashicorp.com/terraform/registry/modules/publish) to setup and publish a Terraform module to a Terraform registry. - -{{% /codetab %}} - -{{< /tabs >}} - -### Step 5: Register your Recipe with your environment - -Now that your Recipe template has been stored, you can add it your Radius Environment to be used by developers. This allows you to mix-and-match templates for each of your environments such as dev, canary, and prod. - -{{< tabs "rad CLI - Bicep" "rad CLI - Terraform" "Bicep environment" >}} - -{{% codetab %}} - -```bash -rad recipe register myrecipe --environment myenv --resource-type Applications.Datastores/redisCaches --template-kind bicep --template-path ghcr.io/USERNAME/recipes/myrecipe:1.1.0 -``` - -{{% /codetab %}} - -{{% codetab %}} - -The template path value should represent the source path found in your Terraform module registry. - -```bash -rad recipe register myrecipe --environment myenv --resource-type Applications.Datastores/redisCaches --template-kind terraform --template-path user/recipes/myrecipe --template-version "1.1.0" -``` - -{{% /codetab %}} - -{{% codetab %}} - -{{< rad file="snippets/environment.bicep" embed=true >}} - -{{% /codetab %}} - -{{< /tabs >}} - -### Step 6 : Use the custom recipe in your application - -You can now use your custom Recipe with its accompanying resource in your application. - -> Note that if your Recipe is registered with the name "default", you do not need to provide a Recipe name in your application, as it will automatically pick up the default Recipe. - -{{< rad file="snippets/redis.bicep" embed=true marker="//REDIS" >}} - -## Further reading - -- [Recipes overview]({{< ref "concepts/recipes" >}}) -- [`rad recipe CLI reference`]({{< ref rad_recipe >}}) diff --git a/docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep deleted file mode 100644 index 0661b9686..000000000 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep +++ /dev/null @@ -1,33 +0,0 @@ -extension radius - -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'prod' - properties: { - compute: { - kind: 'kubernetes' - resourceId: 'self' - namespace: 'default' - } - recipes: { - 'Applications.Datastores/redisCaches':{ - 'redis-bicep': { - templateKind: 'bicep' - templatePath: 'https://ghcr.io/USERNAME/recipes/myrecipe:1.1.0' - // Optionally set parameters for all resources calling this Recipe - parameters: { - port: 3000 - } - } - 'redis-terraform': { - templateKind: 'terraform' - templatePath: 'user/recipes/myrecipe' - templateVersion: '1.1.0' - // Optionally set parameters for all resources calling this Recipe - parameters: { - port: 3000 - } - } - } - } - } -} diff --git a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-main.tf b/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-main.tf deleted file mode 100644 index 77d038985..000000000 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-main.tf +++ /dev/null @@ -1,61 +0,0 @@ -terraform { - required_providers { - kubernetes = { - source = "hashicorp/kubernetes" - version = ">= 2.0" - } - } -} - -resource "kubernetes_deployment" "redis" { - metadata { - name = "redis-${sha512(var.context.resource.id)}" - namespace = var.context.runtime.kubernetes.namespace - labels = { - app = "redis" - } - } - spec { - selector { - match_labels = { - app = "redis" - resource = var.context.resource.name - } - } - template { - metadata { - labels = { - app = "redis" - resource = var.context.resource.name - } - } - spec { - container { - name = "redis" - image = "redis:6" - port { - container_port = 6379 - } - } - } - } - } -} - -resource "kubernetes_service" "redis" { - metadata { - name = "redis-${sha512(var.context.resource.id)}" - namespace = var.context.runtime.kubernetes.namespace - } - spec { - type = "ClusterIP" - selector = { - app = "redis" - resource = var.context.resource.name - } - port { - port = var.port - target_port = "6379" - } - } -} diff --git a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-output.tf b/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-output.tf deleted file mode 100644 index 3b0bc4bfc..000000000 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-output.tf +++ /dev/null @@ -1,19 +0,0 @@ -output "result" { - value = { - values = { - host = "${kubernetes_service.metadata.name}.${kubernetes_service.metadata.namespace}.svc.cluster.local" - port = kubernetes_service.spec.port[0].port - username = "" - } - secrets = { - password = "" - } - // UCP resource IDs - resources = [ - "/planes/kubernetes/local/namespaces/${kubernetes_service.metadata.namespace}/providers/core/Service/${kubernetes_service.metadata.name}", - "/planes/kubernetes/local/namespaces/${kubernetes_deployment.metadata.namespace}/providers/apps/Deployment/${kubernetes_deployment.metadata.name}" - ] - } - description = "The result of the Recipe. Must match the target resource's schema." - sensitive = true -} \ No newline at end of file diff --git a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-variables.tf b/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-variables.tf deleted file mode 100644 index 03e872741..000000000 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes-variables.tf +++ /dev/null @@ -1,14 +0,0 @@ -//PARAMETERS -variable "port" { - description = "The port Redis is offered on. Defaults to 6379." - type = number - default = 6379 -} -//PARAMETERS - -//CONTEXT -variable "context" { - description = "Radius-provided object containing information about the resource calling the Recipe." - type = any -} -//CONTEXT \ No newline at end of file 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 deleted file mode 100644 index 5280bb153..000000000 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes.bicep +++ /dev/null @@ -1,92 +0,0 @@ -//PARAMETERS -@description('The port Redis is offered on. Defaults to 6379.') -param port int = 6379 -//PARAMETERS - -//RESOURCE -@description('Radius-provided object containing information about the resource calling the Recipe') -param context object - -// Import Kubernetes resources into Bicep -extension kubernetes with { - kubeConfig: '' - namespace: context.runtime.kubernetes.namespace -} - -resource redis 'apps/Deployment@v1' = { - metadata: { - // Ensure the resource name is unique and repeatable - name: 'redis-${uniqueString(context.resource.id)}' - } - spec: { - selector: { - matchLabels: { - app: 'redis' - resource: context.resource.name - } - } - template: { - metadata: { - labels: { - app: 'redis' - resource: context.resource.name - } - } - spec: { - containers: [ - { - name: 'redis' - image: 'redis:6' - ports: [ - { - containerPort: 6379 - } - ] - - } - ] - } - } - } -} - -resource svc 'core/Service@v1' = { - metadata: { - name: 'redis-${uniqueString(context.resource.id)}' - } - spec: { - type: 'ClusterIP' - selector: { - app: 'redis' - resource: context.resource.name - } - ports: [ - { - port: port - targetPort: '6379' - } - ] - } -} -//RESOURCE - -//OUTPUT -@description('The result of the Recipe. Must match the target resource\'s schema.') -output result object = { - values: { - host: '${svc.metadata.name}.${svc.metadata.namespace}.svc.cluster.local' - port: svc.spec.ports[0].port - username: '' - } - secrets: { - // Temporarily disable linter until secret outputs are added - #disable-next-line outputs-should-not-contain-secrets - password: '' - } - // UCP IDs for the above Kubernetes resources - resources: [ - '/planes/kubernetes/local/namespaces/${svc.metadata.namespace}/providers/core/Service/${svc.metadata.name}' - '/planes/kubernetes/local/namespaces/${redis.metadata.namespace}/providers/apps/Deployment/${redis.metadata.name}' - ] -} -//OUTPUT diff --git a/docs/content/guides/recipes/howto-author-recipes/snippets/redis.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/redis.bicep deleted file mode 100644 index ccbfc08bb..000000000 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/redis.bicep +++ /dev/null @@ -1,20 +0,0 @@ -extension radius - -param environment string - -param application string - -//REDIS -resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview'= { - name: 'myresource' - properties: { - environment: environment - application: application - recipe: { - name: 'myrecipe' - } - } -} -//REDIS - - diff --git a/docs/content/guides/recipes/howto-dev-recipes/index.md b/docs/content/guides/recipes/howto-dev-recipes/index.md deleted file mode 100644 index 03711ee8e..000000000 --- a/docs/content/guides/recipes/howto-dev-recipes/index.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -type: docs -title: "How-To: Use local-dev Recipes" -linkTitle: "local-dev Recipes" -description: "Learn how to use the pre-defined Recipes that makes it easy to run dependencies in your application." -weight: 200 -categories: "How-To" -tags: ["recipes"] ---- - -Local development environments created by the rad init command include a set of pre-defined Recipes called [`local-dev` Recipes]({{< ref "concepts/recipes" >}}), to get lightweight containerized infrastructure up and running quickly. This guide teaches how to use a local dev recipe to deploy a Redis container to a Kubernetes cluster. - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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 - -1. Begin in a new directory for your application: - - ```bash - mkdir recipes - cd recipes - ``` -1. Initialize a new dev environment: - - ```bash - rad init - ``` - - **Select 'No' when prompted to create an application.** - -1. Use [`rad recipe list`]({{< ref rad_recipe_list >}}) to view the Recipes in your environment: - - ```bash - rad recipe list - ``` - - You should see a table of available Recipes: - - ``` - NAME TYPE TEMPLATE KIND TEMPLATE VERSION TEMPLATE - default Applications.Datastores/sqlDatabases bicep ghcr.io/radius-project/recipes/local-dev/sqldatabases:latest - default Applications.Messaging/rabbitMQQueues bicep ghcr.io/radius-project/recipes/local-dev/rabbitmqqueues:latest - default Applications.Dapr/pubSubBrokers bicep ghcr.io/radius-project/recipes/local-dev/pubsubbrokers:latest - default Applications.Dapr/secretStores bicep ghcr.io/radius-project/recipes/local-dev/secretstores:latest - default Applications.Dapr/stateStores bicep ghcr.io/radius-project/recipes/local-dev/statestores:latest - default Applications.Datastores/mongoDatabases bicep ghcr.io/radius-project/recipes/local-dev/mongodatabases:latest - default Applications.Datastores/redisCaches bicep ghcr.io/radius-project/recipes/local-dev/rediscaches:latest - ``` - - > Visit the [Recipes repo](https://github.com/radius-project/recipes) to learn more about the definition of these `local-dev` recipe templates. - - 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: 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: - -{{< rad file="snippets/app.bicep" embed=true >}} - -Note that no Recipe name is specified within 'db', so it will be using the default Recipe for Redis in your environment. - -## Step 4: Deploy your application - -1. Run [`rad run`]({{< ref rad_run >}}) to deploy your application: - - ```bash - rad run ./app.bicep -a local-dev-app - ``` - - You should see the following output: - - ``` - Building app.bicep... - Deploying template './app.bicep' for application 'local-dev-app' and environment 'default' from workspace 'default'... - - Deployment In Progress... - - Completed db Applications.Datastores/redisCaches - Completed frontend Applications.Core/containers - - Deployment Complete - - Resources: - frontend Applications.Core/containers - db Applications.Datastores/redisCaches - - Starting log stream... - ``` - - Your application is now deployed and running in your Kubernetes cluster. - -## Step 5: Verify Redis containers are deployed - -1. Visit [`http://localhost:3000`](http://localhost:3000) in your browser. - - You can now see both the environment variables of your container under Radius Connections as well as interact with the `Todo App` and add/remove items in it as wanted: - -1. List your Kubernetes Pods to see the infrastructure containers deployed by the Recipe: - - ```bash - kubectl get pods -n default-local-dev-app - ``` - - You will see your 'frontend' container, along with the Redis cache that was automatically created by the default local-dev Recipe: - - ``` - NAME READY STATUS RESTARTS AGE - frontend-6d447f5994-pnmzv 1/1 Running 0 13m - redis-ymbjcqyjzwkpg-66fdbf8bb6-brb6q 2/2 Running 0 13m - ``` diff --git a/docs/content/guides/recipes/howto-dev-recipes/snippets/app.bicep b/docs/content/guides/recipes/howto-dev-recipes/snippets/app.bicep deleted file mode 100644 index 0951be2a1..000000000 --- a/docs/content/guides/recipes/howto-dev-recipes/snippets/app.bicep +++ /dev/null @@ -1,33 +0,0 @@ -extension radius - -@description('The ID of your Radius environment. Automatically injected by the rad CLI.') -param environment string - -@description('The ID of your Radius application. Automatically injected by the rad CLI.') -param application string - -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - } - connections: { - // Define a connection to the redis container - // Automatically injects conneciton information into the container - redis: { - source: db.id - } - } - } -} - -resource db 'Applications.Datastores/redisCaches@2023-10-01-preview' = { - name: 'db' - properties: { - environment: environment - application: application - // recipe is not specified, so it uses 'default' if present - } -} diff --git a/docs/content/guides/recipes/howto-private-bicep-registry/env-deploy-output.png b/docs/content/guides/recipes/howto-private-bicep-registry/env-deploy-output.png deleted file mode 100644 index cc2d19951..000000000 Binary files a/docs/content/guides/recipes/howto-private-bicep-registry/env-deploy-output.png and /dev/null differ diff --git a/docs/content/guides/recipes/howto-private-bicep-registry/index.md b/docs/content/guides/recipes/howto-private-bicep-registry/index.md deleted file mode 100644 index c8474921f..000000000 --- a/docs/content/guides/recipes/howto-private-bicep-registry/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -type: docs -title: "How-To: Pull Bicep Recipes from private OCI container registry." -linkTitle: "Private bicep registries" -description: "Learn how to setup your Radius environment to use Bicep Recipe templates published to a private OCI container registry." -weight: 500 -categories: "How-To" -tags: ["recipes", "bicep"] ---- - -This guide will describe how to: - -- Configure a Radius environment to utilize Bicep Recipe templates that are stored in a private OCI (Open Container Initiative) complaint container registry. This setup will ensure the templates are securely stored within a private OCI registry and accessed by Radius using required credentials. - -### Prerequisites - -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" >}}) -- [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 >}}) - -## Step 1: Obtain private OCI container registry authentication credentials -Radius supports three authentication methods for accessing private container registries: -- Basic Authentication: This method uses a username and password for authentication and is applicable to all OCI complaint registries. Obtain the `username` and `password` details used to login to private registry. -- Azure Workload Identity: This federated identity-based authentication is used for connecting to Azure Container Registry (ACR). [Here]({{< ref howto-azure-provider-wi >}}) is the guide to setup Azure Workload Identity for Radius. Obtain `clientId` and `tenant ID` used during the setup. -- AWS IRSA: This federated identity-based authentication is used for accessing Amazon Elastic Container Registry (ECR). [Here]({{< ref howto-aws-provider-irsa >}}) is the guide to setup the AWS IRSA for Radius. Obtain `roleARN` from the role created during the setup. - -## Step 2: Define a secret store resource - -Create a [Radius Secret Store]({{< ref "/guides/author-apps/secrets/overview" >}}) to securely store and manage the secrets information required for authenticating with a private registry. Define the namespace for the cluster that will contain your [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/) with the `resource` property and specify the type of secret e.g. `basicAuthentication`, `azureWorkloadIdeneity`, `awsIRSA`. - -> While this example shows a Radius-managed secret store where Radius creates the underlying secrets infrastructure, you can also bring your own existing secrets. Refer to the [secrets documentation]({{< ref "/guides/author-apps/secrets/overview" >}}) for more information. - -Secret store example for secret type `awsIRSA`: -{{< rad file="snippets/env.bicep" embed=true marker="//SECRETSTORE" >}} - -## Step 3: Configure authentication for private bicep registries and add a Bicep recipe - -`recipeConfig` allows you to configure how Recipes should be setup and run. One available option is to specify the registry secrets for pulling Bicep Recipes from private registries. For more information refer to the [Radius Environment schema]({{< ref environment-schema >}}) page. - -In your `env.bicep` file add an Environment resource that includes a `recipeConfig` which leverages the previously defined secret store for private OCI registry authentication. - -{{< rad file="snippets/env.bicep" embed=true marker="//ENV" >}} - - -## Step 5: Deploy your Radius Environment - -Deploy your new Radius Environment: - -``` -rad deploy ./env.bicep -``` -{{< image src="env-deploy-output.png" width=700px alt="Screenshot of environment deployment output" >}}
- -Your Radius Environment is now ready to utilize your Radius Recipes stored inside your private registry. For more information on Radius Recipes visit the [Recipes overview page]({{< ref "concepts/recipes" >}}). - -## Cleanup - -You can delete a Radius Environment by running the following command: - -``` -rad env delete my-env -``` - -## Further reading - -- [Recipes overview]({{< ref "concepts/recipes" >}}) -- [Radius Environments]({{< ref "concepts/environments" >}}) -- [`rad recipe CLI reference`]({{< ref rad_recipe >}}) -- [`rad env CLI reference`]({{< ref rad_environment >}}) \ No newline at end of file diff --git a/docs/content/guides/recipes/howto-private-bicep-registry/snippets/env.bicep b/docs/content/guides/recipes/howto-private-bicep-registry/snippets/env.bicep deleted file mode 100644 index cefd84e59..000000000 --- a/docs/content/guides/recipes/howto-private-bicep-registry/snippets/env.bicep +++ /dev/null @@ -1,44 +0,0 @@ -//ENV -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'my-env' - properties: { - compute: { - kind: 'kubernetes' - namespace: 'my-namespace' - } - recipeConfig: { - bicep:{ - authentication:{ - // The hostname of your container registry, such as 'docker.io' or '.azurecr.io' - '.dkr.ecr..amazonaws.com':{ - secret: registrySecrets.id - } - } - } - } - recipes: { - 'Applications.Messaging/rabbitMQQueues': { - default: { - templateKind: 'bicep' - templatePath: '.dkr.ecr..amazonaws.com/test-private-ecr:2.0' - } - } - } - } -} -//ENV - -//SECRETSTORE -resource registrySecrets 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'registry-secrets' - properties: { - resource: 'registry-secrets/ecr' - type: 'awsIRSA' - data: { - roleARN: { - value: 'arn:aws:iam:::role/test-role' - } - } - } -} -//SECRETSTORE diff --git a/docs/content/guides/recipes/terraform/_index.md b/docs/content/guides/recipes/terraform/_index.md deleted file mode 100644 index 78af71bfc..000000000 --- a/docs/content/guides/recipes/terraform/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Terraform Radius Recipes" -linkTitle: "Terraform Radius Recipes" -description: "Learn how to automate infrastructure deployment for your resources with Terraform Radius Recipes" -weight: 500 ---- diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/index.md b/docs/content/guides/recipes/terraform/howto-custom-provider/index.md deleted file mode 100644 index 8e684ff74..000000000 --- a/docs/content/guides/recipes/terraform/howto-custom-provider/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -type: docs -title: "How-To: Configure custom Terraform Providers" -linkTitle: "Custom Terraform Providers" -description: "Learn how to setup your Radius Environment with custom Terraform Providers and deploy Recipes." -weight: 500 -categories: "How-To" -aliases : ["/guides/recipes/terraform/howto-custom-provider"] -tags: ["recipes", "terraform"] ---- - -This how-to guide will describe how to: - -- Configure a custom [Terraform provider](https://registry.terraform.io/browse/providers) in a Radius Environment. -- Configure credentials to authenticate into the Terraform provider. -- Consume the Terraform modules from a custom Terraform provider and use it in a Terraform recipe. - -In this example you're going to configure a [PostgreSQL Terraform provider](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs) in a Radius Environment and deploy a Recipe. - -### Prerequisites - -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" >}}) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- [Radius initialized with `rad init`]({{< ref howto-environment >}}) -- [Recipes overview]({{< ref "concepts/recipes" >}}) - -## Step 1: Define a secretStore resource for the custom provider - -Configure a [Radius Secret Store]({{< ref "/guides/author-apps/secrets/overview" >}}) with any sensitive information needed as input configuration for the custom Terraform Provider. Define the namespace for the cluster that will contain your [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/) with the `resource` property. - -> While this example shows a Radius-managed secret store where Radius creates the underlying secrets infrastructure, you can also bring your own existing secrets. Refer to the [secrets documentation]({{< ref "/guides/author-apps/secrets/overview" >}}) for more information. - -Create a Bicep file `env.bicep` with the secretStore resource: - -{{< rad file="snippets/env.bicep" embed=true marker="//SECRETSTORE" >}} - -> In this example, you're creating a secret with keys `username` and `password` as sensitive data required to authenticate into the Terraform Provider `cyrilgdn/postgresql`. - -## Step 2: Configure Terraform Provider - -`recipeConfig/terraform/providers` allows you to setup configurations for one or multiple Terraform Providers. For more information refer to the [Radius Environment schema]({{< ref environment-schema >}}) page. - -In your `env.bicep` file add an Environment resource, along with Recipe configuration which leverages properties from the previously defined secret store. In this example you're also passing in `host` and `port` as environment variables to highlight use cases where, depending on provider configuration requirements, users can pass environment variables as plain text and as secret values in `envSecrets` block to the Terraform recipes runtime. - -{{< rad file="snippets/env.bicep" embed=true marker="//ENV" >}} - -## Step 3: Define a Terraform Recipe - -Create a Terraform recipe which deploys a PostgreSQL database instance using custom Terraform provider `cyrilgdn/postgresql`. - -{{< rad file="snippets/postgres.tf" embed=true marker="//ENV" >}} - -## Step 4: Add a Terraform Recipe to the Environment - -Update your Environment with the Terraform Recipe. - -{{< rad file="snippets/env-complete.bicep" embed=true marker="//ENV" markdownConfig="{linenos=table,hl_lines=[\"37-45\"],linenostart=30,lineNos=false}" >}} - -## Step 5: Deploy your Radius Environment - -Deploy your new Radius Environment passing in values for `username` and `password` needed to authenticate into the provider. The superuser for this PostgreSQL Recipe is `postgres` which is the expected input for `username`: - -```bash -rad deploy ./env.bicep -p username=****** -p password=****** -``` - -## Done - -Your Radius Environment is now configured with a custom Terraform Provider which you can use to deploy Radius Terraform Recipes. For more information on Radius Recipes visit the [Recipes overview page]({{< ref "concepts/recipes" >}}). - -## Cleanup - -You can delete the Radius Environment by running the following command: - -```bash -rad env delete my-env -``` - -## Further reading - -- [Recipes overview]({{< ref "concepts/recipes" >}}) -- [Radius Environments]({{< ref "concepts/environments" >}}) -- [`rad recipe CLI reference`]({{< ref rad_recipe >}}) -- [`rad env CLI reference`]({{< ref rad_environment >}}) \ No newline at end of file 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 deleted file mode 100644 index 8e49cb3af..000000000 --- a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep +++ /dev/null @@ -1,80 +0,0 @@ -//SECRETSTORE -extension radius - -@description('username for postgres db') -@secure() -param username string - -@description('password for postgres db') -@secure() -param password string - -resource pgsSecretStore 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'my-secret-store' - properties: { - resource: 'my-secret-namespace/my-secret-store' - type: 'generic' - data: { - username: { - value: username - } - password: { - value: password - } - host: { - value: 'my-postgres-host' - } - } - } -} -//SECRETSTORE - -//ENV -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'my-env' - properties: { - compute: { - kind: 'kubernetes' - resourceId: 'self' - namespace: 'my-namespace' - } - recipeConfig: { - terraform: { - providers: { - postgresql: [ { - sslmode: 'disable' - secrets: { - username: { - source: pgsSecretStore.id - key: username - } - password: { - source: pgsSecretStore.id - key: password - } - } - } ] - } - } - env: { - PGPORT: '5432' - } - envSecrets: { - PGHOST: { - source: pgsSecretStore.id - key: 'host' - } - } - } - recipes: { - 'Applications.Core/extenders': { - defaultpostgres: { - templateKind: 'terraform' - // Recipe template path - templatePath: 'git::https://github.com/my-org/my-repo' - } - } - } - } -} -//ENV 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 deleted file mode 100644 index b238d6d5a..000000000 --- a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep +++ /dev/null @@ -1,71 +0,0 @@ -//SECRETSTORE -extension radius - -@description('username for PostgreSQL db') -@secure() -param username string - -@description('password for PostgreSQL db') -@secure() -param password string - -resource pgsSecretStore 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'my-secret-store' - properties: { - resource: 'my-secret-namespace/my-secret-store' - type: 'generic' - data: { - username: { - value: username - } - password: { - value: password - } - host: { - value: 'my-postgres-host' - } - } - } -} -//SECRETSTORE - -//ENV -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'my-env' - properties: { - compute: { - kind: 'kubernetes' - resourceId: 'self' - namespace: 'my-namespace' - } - recipeConfig: { - terraform: { - providers: { - postgresql: [ { - sslmode: 'disable' - secrets: { - username: { - source: pgsSecretStore.id - key: username - } - password: { - source: pgsSecretStore.id - key: password - } - } - } ] - } - } - env: { - PGPORT: '5432' - } - envSecrets: { - PGHOST: { - source: pgsSecretStore.id - key: 'host' - } - } - } - } -} -//ENV diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/postgres.tf b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/postgres.tf deleted file mode 100644 index 422147ba0..000000000 --- a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/postgres.tf +++ /dev/null @@ -1,89 +0,0 @@ -terraform { - required_providers { - kubernetes = { - source = "hashicorp/kubernetes" - version = ">= 2.0" - } - postgresql = { - source = "cyrilgdn/postgresql" - version = "1.16.0" - } - } -} - -variable "context" { - description = "This variable contains Radius recipe context." - type = any -} - -variable "password" { - description = "The password for the PostgreSQL database" - type = string -} - -resource "kubernetes_deployment" "postgres" { - metadata { - name = "postgres" - namespace = var.context.runtime.kubernetes.namespace - } - - spec { - selector { - match_labels = { - app = "postgres" - } - } - - template { - metadata { - labels = { - app = "postgres" - } - } - - spec { - container { - image = "postgres:latest" - name = "postgres" - - env { - name = "POSTGRES_PASSWORD" - value = var.password - } - - port { - container_port = 5432 - } - } - } - } - } -} - -resource "kubernetes_service" "postgres" { - metadata { - name = "postgres" - namespace = var.context.runtime.kubernetes.namespace - } - - spec { - selector = { - app = "postgres" - } - - port { - port = 5432 - target_port = 5432 - } - } -} - -resource "time_sleep" "wait_20_seconds" { - depends_on = [kubernetes_service.postgres] - create_duration = "20s" -} - -resource "postgresql_database" "pg_db_test" { - depends_on = [time_sleep.wait_20_seconds] - name = "pg_db_test" -} diff --git a/docs/content/guides/recipes/terraform/howto-private-registry/index.md b/docs/content/guides/recipes/terraform/howto-private-registry/index.md deleted file mode 100644 index 60fd2fdc0..000000000 --- a/docs/content/guides/recipes/terraform/howto-private-registry/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -type: docs -title: "How-To: Pull Terraform modules from private git repositories" -linkTitle: "Private git repos" -description: "Learn how to setup your Radius environment to pull Terraform Recipe templates from a private git repository." -weight: 500 -categories: "How-To" -aliases : ["/guides/recipes/terraform/howto-private-registry"] -tags: ["recipes", "terraform"] ---- - -This how-to guide will describe how to: - -- Configure a Radius Environment to be able to pull Terraform Recipe templates from a private git repository. - -### Prerequisites - -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" >}}) -- [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 >}}) - -## Step 1: Create a personal access token - -Create a personal access token, this can be from [GitHub](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#about-personal-access-tokens), [GitLab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html), [Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows), or any other Git platform. - -The PAT should have access to read the files inside the specific private repository. - -## Step 2: Define a secret store resource - -Configure a [Radius Secret Store]({{< ref "/guides/author-apps/secrets/overview" >}}) with the username and personal access token (or password) you previously created. Both are required to access your private git repository. Define the namespace for the cluster that will contain your [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/) with the `resource` property. - -> While this example shows a Radius-managed secret store where Radius creates the underlying secrets infrastructure, you can also bring your own existing secrets. Refer to the [secrets documentation]({{< ref "/guides/author-apps/secrets/overview" >}}) for more information. - -Create a Bicep file `env.bicep`, import Radius, and define your resource: - -{{< rad file="snippets/env.bicep" embed=true marker="//SECRETSTORE" >}} - -> Both properties `username` and `pat` are required. `username` refers to your username for the git platform, and `pat` refers to your personal access token or password. - -## Step 3: Configure Terraform Recipe git authentication - -`recipeConfig` allows you to configure how Recipes should be setup and run. One available option is to specify git credentials for pulling Terraform Recipes from git sources. For more information refer to the [Radius Environment schema]({{< ref environment-schema >}}) page. - -In your `env.bicep` file add an Environment resource, along with Recipe configuration which leverages the previously defined secret store for git authentication. - -{{< rad file="snippets/env.bicep" embed=true marker="//ENV" >}} - -## Step 4: Add a Terraform Recipe - -Update your Environment with a Terraform Recipe, pointing to your private git repository. Note that your `templatePath` should contain a `git::` prefix, per the [Terraform module documentation](https://developer.hashicorp.com/terraform/language/modules/sources#generic-git-repository). - -{{< rad file="snippets/env-complete.bicep" embed=true marker="//ENV" markdownConfig="{linenos=table,hl_lines=[\"22-30\"],linenostart=30,lineNos=false}" >}} - -## Step 5: Deploy your Radius Environment - -Deploy your new Radius Environment: - -``` -rad deploy ./env.bicep -p user= -p pat= -``` - -## Done - -Your Radius Environment is now ready to utilize your Radius Recipes stored inside your private registry. For more information on Radius Recipes visit the [Recipes overview page]({{< ref "concepts/recipes" >}}). - -## Cleanup - -You can delete a Radius Environment by running the following command: - -``` -rad env delete my-env -``` - -## Further reading - -- [Recipes overview]({{< ref "concepts/recipes" >}}) -- [Radius Environments]({{< ref "concepts/environments" >}}) -- [`rad recipe CLI reference`]({{< ref rad_recipe >}}) -- [`rad env CLI reference`]({{< ref rad_environment >}}) \ No newline at end of file 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 deleted file mode 100644 index 1bb43089f..000000000 --- a/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env-complete.bicep +++ /dev/null @@ -1,61 +0,0 @@ -//SECRETSTORE -extension radius - -@description('Required value, refers to the username of the git platform') -param user string - -@description('Required value, refers to the personal access token or password of the git platform') -@secure() -param pat string - -resource secretStoreGit 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'my-git-secret-store' - properties: { - resource: 'my-secret-namespace/github' - type: 'generic' - data: { - username: { - value: user - } - pat: { - value: pat - } - } - } -} -//SECRETSTORE - -//ENV -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'my-env' - properties: { - compute: { - kind: 'kubernetes' - namespace: 'my-namespace' - } - recipeConfig: { - terraform: { - authentication: { - git: { - pat: { - // The hostname of your git platform, such as 'dev.azure.com' or 'github.com' - 'github.com':{ - secret: secretStoreGit.id - } - } - } - } - } - } - recipes: { - 'Applications.Datastores/redisCaches': { - default: { - templateKind: 'terraform' - // Git template path - templatePath:'git::https://github.com/my-org/my-repo' - } - } - } - } -} -//ENV 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 deleted file mode 100644 index 1c17fa1c3..000000000 --- a/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env.bicep +++ /dev/null @@ -1,52 +0,0 @@ -//SECRETSTORE -extension radius - -@description('Required value, refers to the username of the git platform') -param user string - -@description('Required value, refers to the personal access token or password of the git platform') -@secure() -param pat string - -resource secretStoreGit 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'my-git-secret-store' - properties: { - resource: 'my-secret-namespace/github' - type: 'generic' - data: { - username: { - value: user - } - pat: { - value: pat - } - } - } -} -//SECRETSTORE - -//ENV -resource env 'Applications.Core/environments@2023-10-01-preview' = { - name: 'my-env' - properties: { - compute: { - kind: 'kubernetes' - namespace: 'my-namespace' - } - recipeConfig: { - terraform: { - authentication: { - git: { - pat: { - // The hostname of your git platform, such as 'dev.azure.com' or 'github.com' - 'github.com':{ - secret: secretStoreGit.id - } - } - } - } - } - } - } -} -//ENV diff --git a/docs/content/guides/recipes/terraform/overview/index.md b/docs/content/guides/recipes/terraform/overview/index.md deleted file mode 100644 index 32d64d7e4..000000000 --- a/docs/content/guides/recipes/terraform/overview/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -type: docs -title: "Overview: Terraform recipes" -linkTitle: "Overview" -description: "Add Terraform based Radius Recipes to your Radius Application" -weight: 100 -categories: "Overview" -tags: ["recipes","Terraform"] ---- - -For a general explanation on Recipes as a concept visit the general [Recipes overview]({{< ref "concepts/recipes" >}}) page. - -## Capabilities - -### Private Git repositories - -Radius supports the use of Terraform modules from private Git repositories as templates for Radius Recipes from any Git platforms such as GitHub, Azure DevOps, Bitbucket, and Gitlab. - -### Leverage any Terraform provider - -Radius Recipes can leverage any Terraform provider allowing users to interact with and manage resources of any specific infrastructure platform or service, such as AWS, Azure, or Google Cloud. - -## Further Reading - -- [Author custom recipes]({{< ref howto-author-recipes >}}) -- [Register a Recipe from a private registry]({{< ref "/guides/recipes/terraform/howto-private-registry" >}}) -- [`rad recipe` CLI reference]({{< ref rad_recipe >}}) -- [Recipes overview]({{< ref "concepts/recipes" >}}) diff --git a/docs/content/guides/tooling/_index.md b/docs/content/guides/tooling/_index.md deleted file mode 100644 index 82a0e9efd..000000000 --- a/docs/content/guides/tooling/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Radius Tooling" -linkTitle: "Tooling" -description: "Learn about Radius tools for managing your applications and Radius installation" -weight: 99 ---- diff --git a/docs/content/guides/tooling/bicepconfig/_index.md b/docs/content/guides/tooling/bicepconfig/_index.md deleted file mode 100644 index 70644d6e3..000000000 --- a/docs/content/guides/tooling/bicepconfig/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -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 deleted file mode 100644 index b6e8a2719..000000000 --- a/docs/content/guides/tooling/bicepconfig/overview/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 Bicep. If you have bicep files with the following import statements, please replace them as needed. - - 1. Change `import radius as radius` to `extension radius` - 1. Change `import aws as aws` to `extension aws` - 1. Change `import kubernetes as kubernetes {}` to `extension kubernetes with {} as kubernetes` -{{< /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 >}} diff --git a/docs/content/guides/tooling/bicepconfig/overview/snippets/app.bicep b/docs/content/guides/tooling/bicepconfig/overview/snippets/app.bicep deleted file mode 100644 index d6623dbf5..000000000 --- a/docs/content/guides/tooling/bicepconfig/overview/snippets/app.bicep +++ /dev/null @@ -1,11 +0,0 @@ -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 deleted file mode 100644 index 699794ba9..000000000 --- a/docs/content/guides/tooling/dashboard/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Radius dashboard" -linkTitle: "Dashboard" -description: "Documentation on the Radius dashboard" -weight: 400 ---- diff --git a/docs/content/guides/tooling/dashboard/overview/dashboard-home.png b/docs/content/guides/tooling/dashboard/overview/dashboard-home.png deleted file mode 100644 index a1ba1004b..000000000 Binary files a/docs/content/guides/tooling/dashboard/overview/dashboard-home.png and /dev/null differ diff --git a/docs/content/guides/tooling/dashboard/overview/index.md b/docs/content/guides/tooling/dashboard/overview/index.md deleted file mode 100644 index bdec6e3d1..000000000 --- a/docs/content/guides/tooling/dashboard/overview/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -type: docs -title: "Overview: Radius Dashboard" -linkTitle: "Overview" -description: "Learn about using the Radius Dashboard to visualize your application graph, environments, and recipes" -weight: 100 -categories: "Overview" -tags: ["dashboard"] ---- - -## What is the Radius Dashboard? - -The Radius Dashboard is the frontend experience for Radius and provides a graphical interface for visualizing your [Application Graph]({{< ref "concepts/applications" >}}), [Environments]({{< ref "concepts/environments" >}}), and [Recipes]({{< ref "concepts/recipes" >}}). It provides both textual and visual representations of your Radius Applications and resources, as well as a directory of Recipes that are available in each Environment. - -{{< image src="dashboard-home.png" alt="screenshot of an example Radius Dashboard home page" width=800 >}} - -## Built with extensibility in mind - -The Radius Dashboard is built on [Backstage](https://backstage.io/), an open-source platform for building developer portals that provides a rich set of components to accelerate UI development. It is a skinned deployment of Backstage that includes a set of plugins that provide the Radius experience. The components that make up the dashboard are built with extensibility in mind so that they can be used in other contexts beyond Backstage in the future. - -## Key features - -The Radius Dashboard currently provides the following features: - -- **Application graph visualization**: A visualization of the [application graph]({{< ref "concepts/applications" >}}) that shows how resources within an application are connected to each other and the underlying infrastructure. -- **Resource overview and details**: Detailed information about resources within Radius, including [applications]({{< ref "concepts/applications" >}}), [environments]({{< ref "concepts/environments" >}}), and infrastructure. -- **Recipes directory**: A listing of all the Radius [Recipes]({{< ref "concepts/recipes" >}}) available to the user for a given environment. - -## Installation - -The Radius Dashboard is installed by default as a part of your Radius initialization and deployment. - -{{< alert title="Opting-out" color="warning" >}} -To opt-out of installing the dashboard, you can use the `--set dashboard.enabled=false` flag when running `rad init` or `rad install kubernetes`. See more instructions in the Radius [initialization]({{< ref "installation#step-3-initialize-radius" >}}) and [installation]({{< ref "guides/operations/kubernetes/kubernetes-install" >}}) guides. -{{< /alert >}} - -To remove the dashboard from your existing installation of Radius on your cluster, you can run: - -```bash -rad install kubernetes --reinstall --set dashboard.enabled=false -``` - -## Accessing the Dashboard - -When you run your application with the `rad run` command, Radius creates a port-forward from `localhost` to port `7007` inside the container that you may use to access your Radius Dashboard by visiting [http://localhost:7007](http://localhost:7007) in a browser. - -Alternatively, you can manually create a port-forward from `localhost` to the port number of your choice to provide access to your Radius Dashboard: - -```bash -kubectl port-forward --namespace=radius-system svc/dashboard 7007:80 -``` diff --git a/docs/content/guides/tooling/rad-cli/_index.md b/docs/content/guides/tooling/rad-cli/_index.md deleted file mode 100644 index 7af1fc278..000000000 --- a/docs/content/guides/tooling/rad-cli/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "rad CLI" -linkTitle: "rad CLI" -description: "Documentation on the rad CLI" -weight: 100 ---- diff --git a/docs/content/guides/tooling/rad-cli/howto-rad-cli/index.md b/docs/content/guides/tooling/rad-cli/howto-rad-cli/index.md deleted file mode 100644 index 005d5727e..000000000 --- a/docs/content/guides/tooling/rad-cli/howto-rad-cli/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -type: docs -title: "How-To: Install the rad CLI" -linkTitle: "Install rad CLI" -description: "Learn how to install the rad CLI on your local machine" -weight: 200 -categories: "How-To" -tags: ["rad CLI", "Bicep"] ---- - -{{< read file= "/shared-content/installation/rad-cli/install-rad-cli.md" >}} diff --git a/docs/content/guides/tooling/rad-cli/overview/index.md b/docs/content/guides/tooling/rad-cli/overview/index.md deleted file mode 100644 index 163cb75d0..000000000 --- a/docs/content/guides/tooling/rad-cli/overview/index.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -type: docs -title: "Overview: rad CLI" -linkTitle: "Overview" -description: "Learn about the rad CLI and how to interact with Radius from your local machine" -weight: 100 -categories: "Overview" -tags: ["rad CLI"] ---- - -The rad Command Line Interface (CLI) allows you to interact with Radius from your local machine. It is the primary way to interact with Radius and is used to create, deploy, and manage your applications, environments, and resources. - -```bash -$ rad -Radius CLI - -Usage: - rad [command] - -Available Commands: - application Manage Radius Applications - bicep Manage bicep compiler - completion Generates shell completion scripts - credential Manage cloud provider credential for a Radius installation. - debug-logs Capture logs from Radius control plane for debugging and diagnostics. - deploy Deploy a template - env Manage Radius Environments - group Manage resource groups - help Help about any command - init Initialize Radius - install Installs Radius for a given platform - recipe Manage recipes - resource Manage resources - run Run an application - uninstall Uninstall Radius for a specific platform - version Prints the versions of the rad cli - workspace Manage workspaces -``` - -## Installation - -The rad CLI is distributed as a single binary that can be installed on Linux, macOS, and Windows. Visit the [installation guide]({{< ref howto-rad-cli >}}) to learn how to install the rad CLI. - -{{< button text="Install rad CLI" page="howto-rad-cli" >}} - -## Binary location - -{{< tabs "macOS/Linux/WSL" "Windows" >}} - -{{% codetab %}} -By default, the rad CLI installation script installs the rad CLI to `/usr/local/bin/rad` - -If you would like to install the rad CLI to a different path, you can specify the path with the `RADIUS_INSTALL_DIR` environment variable: - -```bash -# Install to home directory -export RADIUS_INSTALL_DIR=~/ -``` - -{{% /codetab %}} - -{{% codetab %}} -By default, the rad CLI installation script installs the rad CLI to `%LOCALAPPDATA%\radius\rad.exe` - -{{% /codetab %}} - -{{< /tabs >}} - -## Configuration - -The rad CLI stores its configuration, the Bicep compiler, and other configuration under the `rad` directory. - -{{< tabs "macOS/Linux/WSL" "Windows" >}} - -{{% codetab %}} -The rad CLI stores configuration under `~/.rad` -{{% /codetab %}} - -{{% codetab %}} -The rad CLI stores configuration under `%USERPROFILE%\.rad` -{{% /codetab %}} - -{{< /tabs >}} - -### `config.yaml` file - -The rad CLI stores its configuration in a YAML file named `config.yaml` under the `rad` directory. This file contains [workspaces]({{< ref "/guides/operations/workspaces/overview" >}}), which point to your cluster, your default [resource group]({{< ref "/guides/operations/groups/overview" >}}), and your default [environment]({{< ref "concepts/environments" >}}). - -When the rad CLI runs commands, it will use the configuration in the `config.yaml` file to determine which cluster, resource group, and environment to target and use. - -For more information, refer to the [`config.yaml` reference documentation]({{< ref "/reference/config" >}}). - -### `bicep` compiler - -The rad CLI uses the Bicep compiler to compile Bicep files to JSON templates. The Bicep compiler is stored as `/bin/bicep` within your configuration directory. - -## Reference documentation - -Visit the [reference documentation]({{< ref "/reference/cli" >}}) to learn more about the rad CLI and its commands. - -{{< button text="Reference docs" page="/reference/cli" >}} diff --git a/docs/content/guides/tooling/vscode/_index.md b/docs/content/guides/tooling/vscode/_index.md deleted file mode 100644 index 24533fcf6..000000000 --- a/docs/content/guides/tooling/vscode/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Visual Studio Code tooling" -linkTitle: "VS Code" -description: "Learn how to use Radius in Visual Studio Code" -weight: 200 ---- diff --git a/docs/content/guides/tooling/vscode/howto-vscode-bicep/index.md b/docs/content/guides/tooling/vscode/howto-vscode-bicep/index.md deleted file mode 100644 index d42344343..000000000 --- a/docs/content/guides/tooling/vscode/howto-vscode-bicep/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -type: docs -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" -tags: ["Bicep", "VSCode"] ---- - -{{< read file= "/shared-content/installation/vscode-bicep/install-vscode-bicep.md" >}} \ No newline at end of file diff --git a/docs/content/guides/tooling/vscode/overview/index.md b/docs/content/guides/tooling/vscode/overview/index.md deleted file mode 100644 index 25d29274d..000000000 --- a/docs/content/guides/tooling/vscode/overview/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -type: docs -title: "Overview: Using Radius in Visual Studio Code" -linkTitle: "Overview" -description: "Learn how to use Radius in Visual Studio Code" -weight: 100 -categories: "Overview" -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. - -{{< 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 >}} - -## Bicep extension - -The Bicep extension provides formatting, intellisense, and validation for Bicep templates. - -{{< image src="vscode-bicep.png" alt="Screenshot of the Bicep extension showing available Radius resource types" width=600px >}} -

- -{{< button text="Bicep guide" page="howto-vscode-bicep" >}} - -## Terraform extension - -When authoring [Terraform Recipes]({{< ref "concepts/recipes" >}}) you can use the HashiCorp Terraform extension to help author, validate, and manage your Terraform templates. - -{{< button text="Terraform extension" link="https://marketplace.visualstudio.com/items?itemName=hashicorp.terraform" newtab="true" >}} \ No newline at end of file diff --git a/docs/content/guides/tooling/vscode/overview/vscode-bicep.png b/docs/content/guides/tooling/vscode/overview/vscode-bicep.png deleted file mode 100644 index 0e4c60f84..000000000 Binary files a/docs/content/guides/tooling/vscode/overview/vscode-bicep.png and /dev/null differ diff --git a/docs/content/installation/_index.md b/docs/content/installation/_index.md new file mode 100644 index 000000000..ac4bc0d83 --- /dev/null +++ b/docs/content/installation/_index.md @@ -0,0 +1,42 @@ +--- +type: docs +title: "How to Install Radius" +linkTitle: "Install Radius" +description: "Learn how to install Radius on Kubernetes, configure cloud providers, and set up developer workstations" +weight: 400 +aliases: + - /guides/installation/ +--- + +Radius runs as a control plane on a Kubernetes cluster with a command-line interface for performing Radius commands. This guide covers how to install and configure each component required to run Radius. This includes: + +- How to install the [Radius CLI]({{< ref "/installation/cli" >}}) on your workstation. +- How to install the [Radius control plane]({{< ref "/installation/control-plane" >}}) on a Kubernetes cluster. +- How to configure [cloud providers]({{< ref "/installation/cloud-providers" >}}) to deploy to AWS and Azure. +- How to set up a [developer workstation]({{< ref "/installation/dev-workstation" >}}) to use Radius. +- How to configure access to the [Radius Dashboard]({{< ref "/installation/dashboard/" >}}). + +## System requirements + +To install and run the Radius control plane you need: + +- A Kubernetes cluster running a currently supported version. Radius tracks the upstream Kubernetes [version support policy](https://kubernetes.io/releases/version-skew-policy/#supported-versions), which maintains the three most recent minor releases. +- [`kubectl`](https://kubernetes.io/docs/tasks/tools/) installed and configured with a context pointing to your target cluster. +- Cluster-administrator (`cluster-admin`) access to the cluster. Radius installs CRDs, namespaces, RBAC resources, and an [aggregated API server](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/), all of which require cluster-wide privileges. +- Outbound network access from the cluster to pull the Radius container images and Helm chart from `ghcr.io`. +- For local clusters (kind or k3d): a container runtime such as Docker Desktop with at least 8 GB of memory allocated. + +### Supported Kubernetes clusters + +Radius is tested and validated against the following Kubernetes distributions: + +- [Azure Kubernetes Service (AKS)](https://learn.microsoft.com/azure/aks/) +- [Amazon Elastic Kubernetes Service (Amazon EKS)](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html) +- [k3d](https://k3d.io) +- [kind](https://kind.sigs.k8s.io/) + +## Organization + +This guide is organized into a separate page for each component you install and configure: the Radius CLI, the control plane, cloud providers, a developer workstation, and the Dashboard. Start with the Radius CLI, then continue through the remaining pages in order. + +{{< button text="Next step: How to install the Radius CLI" page="installation/cli" >}} diff --git a/docs/content/installation/cli/_index.md b/docs/content/installation/cli/_index.md new file mode 100644 index 000000000..1dcfdbe3f --- /dev/null +++ b/docs/content/installation/cli/_index.md @@ -0,0 +1,67 @@ +--- +type: docs +title: "How to install the Radius CLI" +linkTitle: "Radius CLI" +description: "Learn how to install the Radius CLI and customize the installation directory" +weight: 100 +aliases: + - /guides/installation/cli/ + - /guides/installation/rad-cli/ + - /guides/installation/rad-cli/overview/ + - /guides/installation/rad-cli/howto-rad-cli/ +--- + +The Radius command-line interface (`rad`) is the primary way to interact with Radius from your local machine. It is used to install the Radius control plane, create and manage Environments and Resource Groups, and deploy and manage Applications. + +Because Radius uses [Bicep](https://github.com/Azure/bicep) to define Applications and resources, the Bicep CLI is installed when the Radius CLI is installed. Radius uses the Bicep CLI to compile Bicep code into deployable JSON. + +Visit the [reference documentation]({{< ref "/reference/cli" >}}) to learn more about the Radius CLI and its commands. + +## Install the Radius CLI + +The Radius CLI is distributed as a single binary that can be installed on Linux, macOS, and Windows. + +{{< read file="/shared-content/installation/rad-cli/install-rad-cli.md" >}} + +#### Optionally specify the installation directory + +{{< tabs "Linux and macOS" "Windows" >}} + +{{% codetab %}} +By default it installs the Radius CLI to a user-writable location: + +- When run as a normal user: `$HOME/.local/bin/rad` +- When run as `root`: `/usr/local/bin/rad` + +To install to a different path, set the `INSTALL_DIR` environment variable before running the script: + +```bash +# Install to your home directory +export INSTALL_DIR=~/.local/bin +``` + +If the install directory is not on your `PATH`, the script prints the command to add it. +{{% /codetab %}} + +{{% codetab %}} +By default, the installation script installs the Radius CLI to `%LOCALAPPDATA%\radius\rad.exe`. + +To install to a different path, set the `INSTALL_DIR` environment variable before running the script: + +```powershell +# Install to a custom directory +$env:INSTALL_DIR = "$HOME\bin" +``` + +If you installed the CLI with WinGet, the install location is managed by WinGet and added to your `PATH` automatically; the `INSTALL_DIR` variable does not apply. +{{% /codetab %}} + +{{< /tabs >}} + +Verify the installation by running `rad version`. + +## Next steps + +Once the Radius CLI has been installed, install the Radius control plane. + +{{< button text="Next step: How to install the Radius control plane" page="installation/control-plane" >}} diff --git a/docs/content/installation/cloud-providers/_index.md b/docs/content/installation/cloud-providers/_index.md new file mode 100644 index 000000000..b2e105386 --- /dev/null +++ b/docs/content/installation/cloud-providers/_index.md @@ -0,0 +1,24 @@ +--- +type: docs +title: "How to configure cloud provider credentials" +linkTitle: "Cloud provider credentials" +description: "Learn how to configure cloud provider credentials to enable Radius to deploy applications to AWS or Azure" +weight: 300 +aliases: + - /guides/installation/cloud-providers/ + - /guides/installation/cloud-providers/aws/ + - /guides/installation/cloud-providers/azure/ + - /guides/installation/providers/ + - /guides/installation/providers/overview/ +--- + +Out of the box, Radius deploys all applications and resources to Kubernetes. In order to deploy to AWS or Azure, you must configure credentials that allow Radius to manage resources in your cloud environment. + +## Supported cloud providers and identities + +| Provider | Identity | Description | +|----------|----------|-------------| +| Amazon Web Services | [IAM access key]({{< ref "/installation/cloud-providers/aws-access-key" >}}) | Deploy and connect to AWS resources using an IAM access key | +| | [IAM Roles for Service Accounts (IRSA)]({{< ref "/installation/cloud-providers/aws-irsa" >}}) | Deploy and connect to AWS resources using AWS IRSA | +| Microsoft Azure | [Service Principal]({{< ref "/installation/cloud-providers/azure-service-principal" >}}) | Deploy and connect to Azure resources using a Service Principal | +| | [Workload Identity]({{< ref "/installation/cloud-providers/azure-workload-identity" >}}) | Deploy and connect to Azure resources using Workload Identity | diff --git a/docs/content/installation/cloud-providers/aws-access-key/index.md b/docs/content/installation/cloud-providers/aws-access-key/index.md new file mode 100644 index 000000000..baf16a9d9 --- /dev/null +++ b/docs/content/installation/cloud-providers/aws-access-key/index.md @@ -0,0 +1,75 @@ +--- +type: docs +title: "How to configure AWS credentials using an IAM access key" +linkTitle: "AWS IAM Access key" +description: "Learn how to configure an AWS credential using an IAM access key in the Radius control plane" +weight: 100 +aliases: + - /guides/installation/cloud-providers/aws/access-key/ +--- + +Radius authenticates to AWS with an IAM user's access key to deploy and connect to AWS resources. This guide creates an access key and registers it as an AWS credential in the Radius control plane. + +## Step 1: Obtain the access key ID and key + +Radius authenticates to AWS with an IAM user's access key. If you don't already have one, create an access key for the IAM user Radius will use: + +1. Sign in to the [AWS Management Console](https://console.aws.amazon.com/) and open the IAM console. +1. Select **Users**, then select the IAM user. +1. On the **Security credentials** tab, under **Access keys**, select **Create access key**. +1. Select a use case (for example, **Command Line Interface (CLI)**), acknowledge the recommendations, and select **Create access key**. +1. Copy the **Access key ID** and **Secret access key**. The secret access key is shown only once, so store it securely. + +Alternatively, create an access key with the AWS CLI: + +```bash +aws iam create-access-key --user-name myIamUser +``` + +For more information, see [Manage access keys for IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) in the AWS documentation. + +## Step 2a: Interactively via `rad initialize` + +If Radius has not been installed already, [`rad initialize --full`]({{< ref rad_initialize >}}) can be used to interactively install Radius and configure an AWS access key at the same time. + + +```bash +rad initialize --full --preview +``` + +Follow the prompts: + +1. When prompted with **"Add cloud providers for cloud resources?"**, select **Yes**. +1. Select **AWS**, then **Access Key**. +1. Enter the **IAM access key ID** and **secret access key** recorded in [Step 1](#step-1-obtain-the-access-key-id-and-key). +1. Enter the **AWS account ID** and **region** to use for the `default` Environment. + +## Step 2b: Manual configuration + +Create the AWS credential in the Radius control plane with [`rad credential register aws access-key`]({{< ref rad_credential_register_aws_access-key >}}): + +```bash +rad credential register aws access-key --access-key-id myAccessKeyId --secret-access-key mySecretAccessKey +``` + +Radius will use the provided access key for all interactions with AWS. + +## Step 3: Update existing Environments + +If you have existing Environments, you must also update your Environments with your AWS region and AWS account ID: + + +```bash +rad environment update myEnvironment \ + --aws-region myAwsRegion \ + --aws-account-id myAwsAccountId \ + --preview +``` + +This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad environment update`]({{< ref rad_environment_update >}}). + +## Next steps + +Once AWS or Azure credentials are configured, set up access to the Radius Dashboard. + +{{< button text="Next step: How to configure access to the Radius dashboard" page="installation/dashboard" >}} diff --git a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/create-role.png b/docs/content/installation/cloud-providers/aws-irsa/create-role.png similarity index 100% rename from docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/create-role.png rename to docs/content/installation/cloud-providers/aws-irsa/create-role.png diff --git a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/get-role-arn.png b/docs/content/installation/cloud-providers/aws-irsa/get-role-arn.png similarity index 100% rename from docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/get-role-arn.png rename to docs/content/installation/cloud-providers/aws-irsa/get-role-arn.png diff --git a/docs/content/installation/cloud-providers/aws-irsa/index.md b/docs/content/installation/cloud-providers/aws-irsa/index.md new file mode 100644 index 000000000..10bc611f2 --- /dev/null +++ b/docs/content/installation/cloud-providers/aws-irsa/index.md @@ -0,0 +1,141 @@ +--- +type: docs +title: "How to configure AWS credentials using IRSA" +linkTitle: "AWS IRSA" +description: "Learn how to configure AWS credentials using IAM Roles for Service Accounts (IRSA) in the Radius control plane" +weight: 200 +aliases: + - /guides/installation/cloud-providers/aws/irsa/ +--- + +IAM Roles for Service Accounts (IRSA) let Radius deploy and connect to AWS resources without long-lived credentials by assigning an IAM role to the Radius Kubernetes service accounts. This guide creates the IAM role and registers it as an AWS credential in the Radius control plane. + +## Step 1: Create IAM role + +To authorize Radius to connect to AWS using IAM Roles for Service Accounts (IRSA), assign IAM roles to the Kubernetes service accounts used by Radius. Create an IAM role and associate it with a Kubernetes service account. + +- In the AWS Management Console, open Identity and Access Management (IAM) and create a new role. + + {{< image src="create-role.png" width=700px alt="Screenshot of Create Role page in AWS portal" >}} +
+ +- Select `Web Identity` as the `Trusted entity type` and enter the cluster's OIDC URL as the `Identity Provider`. + + {{< image src="select-trust-entity.png" width=700px alt="Screenshot of options to pass while selecting trust entity." >}} + +- Attach an IAM policy that grants the permissions Radius needs to deploy your resources. + +- Enter a role name and create the role using the default trust policy. + +- Update the trust policy to match the format below. + + ```json + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "Federated": "arn:aws:iam:::oidc-provider/" + }, + "Action": "sts:AssumeRoleWithWebIdentity", + "Condition": { + "StringEquals": { + ":aud": "sts.amazonaws.com", + ":sub": "system:serviceaccount:radius-system:ucp" + } + } + }, + { + "Sid": "Statement1", + "Effect": "Allow", + "Principal": { + "Federated": "arn:aws:iam:::oidc-provider/" + }, + "Action": "sts:AssumeRoleWithWebIdentity", + "Condition": { + "StringEquals": { + ":aud": "sts.amazonaws.com", + ":sub": "system:serviceaccount:radius-system:applications-rp" + } + } + }, + { + "Sid": "Statement2", + "Effect": "Allow", + "Principal": { + "Federated": "arn:aws:iam:::oidc-provider/" + }, + "Action": "sts:AssumeRoleWithWebIdentity", + "Condition": { + "StringEquals": { + ":aud": "sts.amazonaws.com", + ":sub": "system:serviceaccount:radius-system:dynamic-rp" + } + } + } + ] + } + ``` + +- Record the IAM role ARN. + + {{< image src="get-role-arn.png" width=700px alt="Screenshot of role details to get role ARN." >}} + +## Step 2a: Interactively via `rad initialize` + +If Radius has not been installed already, [`rad initialize --full`]({{< ref rad_initialize >}}) can be used to interactively install Radius and configure AWS IRSA at the same time. + + +```bash +rad initialize --full --preview +``` + +Follow the prompts: + +1. When prompted with **"Add cloud providers for cloud resources?"**, select **Yes**. +1. Select **AWS**, then **IRSA**. +1. Enter the **IAM role ARN** recorded in [Step 1](#step-1-create-iam-role). +1. Enter the **AWS account ID** and **region** to use for the `default` Environment. + +## Step 2b: Manual configuration + +IRSA requires the Radius control-plane pods to mount a projected AWS web-identity token. If Radius has not been installed, enable it by installing Radius with the `global.aws.irsa.enabled` Helm value set to `true`: + +```bash +rad install kubernetes --set global.aws.irsa.enabled=true +``` + +If Radius is already installed, enable IRSA with an upgrade instead of reinstalling. This restarts the Radius control plane pods with the token mounted: + +```bash +rad upgrade kubernetes --set global.aws.irsa.enabled=true +``` + +Then create the AWS credential in the Radius control plane with [`rad credential register aws irsa`]({{< ref rad_credential_register_aws_irsa >}}): + +```bash +rad credential register aws irsa --iam-role myRoleARN +``` + +Radius will use the provided role ARN for all interactions with AWS. + +## Step 3: Update existing Environments + +If you have existing Environments, you must also update your Environments with your AWS region and AWS account ID: + + +```bash +rad environment update myEnvironment \ + --aws-region myAwsRegion \ + --aws-account-id myAwsAccountId \ + --preview +``` + +This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad environment update`]({{< ref rad_environment_update >}}). + +## Next steps + +Once AWS or Azure credentials are configured, set up access to the Radius Dashboard. + +{{< button text="Next step: How to configure access to the Radius dashboard" page="installation/dashboard" >}} diff --git a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/select-trust-entity.png b/docs/content/installation/cloud-providers/aws-irsa/select-trust-entity.png similarity index 100% rename from docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/select-trust-entity.png rename to docs/content/installation/cloud-providers/aws-irsa/select-trust-entity.png diff --git a/docs/content/installation/cloud-providers/azure-service-principal/index.md b/docs/content/installation/cloud-providers/azure-service-principal/index.md new file mode 100644 index 000000000..0fe32a131 --- /dev/null +++ b/docs/content/installation/cloud-providers/azure-service-principal/index.md @@ -0,0 +1,79 @@ +--- +type: docs +title: "How to configure Azure credentials using a service principal" +linkTitle: "Azure Service Principal" +description: "Learn how to configure Azure credentials using a service principal in the Radius control plane" +weight: 300 +aliases: + - /guides/installation/cloud-providers/azure/service-principal/ +--- + +Radius authenticates to Azure with a service principal to deploy and connect to Azure resources. This guide creates a service principal and registers it as an Azure credential in the Radius control plane. + +## Step 1: Create a service principal + +Radius authenticates to Azure with a service principal. Create one and note the `appId`, `password`, and `tenant`: + +```bash +az ad sp create-for-rbac +``` + +``` +{ + "appId": "****", + "displayName": "****", + "password": "****", + "tenant": "****" +} +``` + +Grant the service principal access to the resource group using the Azure role that allows creating the resources you plan to deploy. + +## Step 2a: Interactively via `rad initialize` + +If Radius has not been installed already, [`rad initialize --full`]({{< ref rad_initialize >}}) can be used to interactively install Radius and configure an Azure service principal at the same time. + + +```bash +rad initialize --full --preview +``` + +Follow the prompts: + +1. When prompted with **"Add cloud providers for cloud resources?"**, select **Yes**. +1. Select **Azure**, then **Service Principal**. +1. Enter the **`appId`**, **`password`**, and **`tenant`** recorded in [Step 1](#step-1-create-a-service-principal). +1. Enter the **Azure subscription ID** and **resource group** to use for the `default` Environment. The resource group must already exist. + +## Step 2b: Manual configuration + +Create the Azure credential in the Radius control plane with [`rad credential register azure sp`]({{< ref rad_credential_register_azure_sp >}}): + +```bash +rad credential register azure sp \ + --client-id myClientId \ + --client-secret myClientSecret \ + --tenant-id myTenantId +``` + +Radius will use the provided service principal for all interactions with Azure. + +## Step 3: Update existing Environments + +If you have existing Environments, you must also update your Environments with your Azure subscription ID and resource group. The resource group must already exist: + + +```bash +rad environment update myEnvironment \ + --azure-subscription-id myAzureSubscriptionId \ + --azure-resource-group myAzureResourceGroup \ + --preview +``` + +This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad environment update`]({{< ref rad_environment_update >}}). + +## Next steps + +Once AWS or Azure credentials are configured, set up access to the Radius Dashboard. + +{{< button text="Next step: How to configure access to the Radius dashboard" page="installation/dashboard" >}} diff --git a/docs/content/installation/cloud-providers/azure-workload-identity/index.md b/docs/content/installation/cloud-providers/azure-workload-identity/index.md new file mode 100644 index 000000000..10d23bf45 --- /dev/null +++ b/docs/content/installation/cloud-providers/azure-workload-identity/index.md @@ -0,0 +1,86 @@ +--- +type: docs +title: "How to configure Azure credentials using workload identity" +linkTitle: "Azure Workload Identity" +description: "Learn how to configure Azure credentials using workload identity in the Radius control plane" +weight: 400 +aliases: + - /guides/installation/cloud-providers/azure/workload-identity/ +--- + +Azure workload identity lets Radius deploy and connect to Azure resources without storing secrets by federating Kubernetes service account tokens with an Entra ID application. This guide sets up workload identity and registers it as an Azure credential in the Radius control plane. + +## Before you begin + +Before configuring workload identity, verify that: + +- [A supported Kubernetes cluster]({{< ref "/installation#supported-kubernetes-clusters" >}}) with its OIDC issuer URL is available. See the [AKS example](https://azure.github.io/azure-workload-identity/docs/installation/managed-clusters.html#azure-kubernetes-service-aks). +- [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/installation.html) is installed in the cluster, including the [Mutating Admission Webhook](https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html). + +## Step 1: Set up Azure workload identity + +To authorize Radius to connect to Azure using workload identity, set up an Entra ID application with access to your resource group. Using the OIDC issuer for your Kubernetes cluster, create one federated credential for each Radius service (`applications-rp`, `bicep-de`, `ucp`, and `dynamic-rp`) in the `radius-system` namespace. + +The following script creates an Entra ID application and the federated credentials Radius needs to authenticate with Azure using workload identity: + +{{< rad file="snippets/install-radius-azwi.sh" embed=true lang=bash >}} + +Record the application's client ID (`appId`) and tenant ID (`tenant`). + +## Step 2a: Interactively via `rad initialize` + +If Radius has not been installed already, [`rad initialize --full`]({{< ref rad_initialize >}}) can be used to interactively install Radius and configure Azure workload identity at the same time. + + +```bash +rad initialize --full --preview +``` + +Follow the prompts: + +1. When prompted with **"Add cloud providers for cloud resources?"**, select **Yes**. +1. Select **Azure**, then **Workload Identity**. +1. Enter the **client ID** (`appId`) and **tenant ID** recorded in [Step 1](#step-1-set-up-azure-workload-identity). +1. Enter the **Azure subscription ID** and **resource group** to use for the `default` Environment. The resource group must already exist. + +## Step 2b: Manual configuration + +Workload identity must be enabled on the Radius control plane. If Radius has not been installed, enable it by installing Radius with the `global.azureWorkloadIdentity.enabled` Helm value set to `true`: + +```bash +rad install kubernetes --set global.azureWorkloadIdentity.enabled=true +``` + +If Radius is already installed, enable workload identity with an upgrade instead of reinstalling. This restarts the Radius control plane pods with the token mounted: + +```bash +rad upgrade kubernetes --set global.azureWorkloadIdentity.enabled=true +``` + +Then create the Azure credential in the Radius control plane with [`rad credential register azure wi`]({{< ref rad_credential_register_azure_wi >}}): + +```bash +rad credential register azure wi --client-id myClientId --tenant-id myTenantId +``` + +Radius will use the provided client ID for all interactions with Azure. + +## Step 3: Update existing Environments + +If you have existing Environments, you must also update your Environments with your Azure subscription ID and resource group: + + +```bash +rad environment update myEnvironment \ + --azure-subscription-id myAzureSubscriptionId \ + --azure-resource-group myAzureResourceGroup \ + --preview +``` + +This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad environment update`]({{< ref rad_environment_update >}}). + +## Next steps + +Once AWS or Azure credentials are configured, set up access to the Radius Dashboard. + +{{< button text="Next step: How to configure access to the Radius dashboard" page="installation/dashboard" >}} diff --git a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/snippets/install-radius-azwi.sh b/docs/content/installation/cloud-providers/azure-workload-identity/snippets/install-radius-azwi.sh similarity index 100% rename from docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/snippets/install-radius-azwi.sh rename to docs/content/installation/cloud-providers/azure-workload-identity/snippets/install-radius-azwi.sh diff --git a/docs/content/installation/control-plane/_index.md b/docs/content/installation/control-plane/_index.md new file mode 100644 index 000000000..005d4951f --- /dev/null +++ b/docs/content/installation/control-plane/_index.md @@ -0,0 +1,120 @@ +--- +type: docs +title: "How to install the Radius control plane" +linkTitle: "Radius control plane" +description: "Learn how to install, customize, upgrade, and uninstall the Radius control plane on Kubernetes" +weight: 200 +aliases: + - /guides/installation/control-plane/ + - /guides/installation/install/ +--- + +There are three ways to install the Radius control plane. They install the same components on the Kubernetes cluster; they differ in how much of the surrounding setup they automate and how much control they give you over the installation. + +- **`rad install`** performs the base installation and is oriented toward platform engineers who are setting up a centralized Radius control plane for developers to connect to. `rad install` accepts `--set` flags to override individual Helm chart values (listed below). +- **`rad initialize`** does everything `rad install` does plus configures the local workstation with a Workspace and Bicep configuration file. It is oriented toward local development, where you install Radius and build an application on the same machine. +- **`helm upgrade radius`** installs only the control plane. It does not create Resource Types, Resource Groups, or Environments. + +The following table summarizes the differences: + +| | `rad initialize` | `rad install` | `helm upgrade radius` | +| --- | --- | --- | --- | +| Installs the control plane | Yes | Yes | Yes | +| Creates common Resource Types | Yes | Yes | No | +| Creates a `default` Resource Group | Yes | Yes | No | +| Creates a `default` Environment | Yes | Yes | No | +| Configures a `default` Workspace | Yes | No | No | +| Creates a `bicepconfig.json` | Yes | No | No | +| Optionally creates a sample `app.bicep` | Yes | No | No | +| Customization | Defaults only | `--set` chart values | Full chart values, version, release name | +| Requires the Radius CLI | Yes | Yes | No | + +Each method is described in detail below. + +## Using `rad initialize` + +[`rad initialize`]({{< ref rad_initialize >}}) is the fastest way to get started. It installs the control plane on the current Kubernetes cluster and configures the local machine in one step: + +```bash +rad initialize +``` + +### Customizing with `rad initialize --full` + +By default, `rad initialize` uses opinionated defaults: it installs into the current Kubernetes context, creates an Environment named `default` that deploys applications into the `default` namespace, and does not configure any cloud providers. + +To choose these settings yourself, run `rad initialize` with the `--full` flag: + +```bash +rad initialize --full +``` + +In full mode, `rad initialize` interactively prompts you for all available configuration options, including: + +- The Kubernetes cluster to install onto +- The Environment name +- The namespace that applications are deployed into +- Azure and AWS [cloud providers]({{< ref "/installation/cloud-providers" >}}) and their credentials + +Use `--full` when the defaults do not match your setup, for example when you want a non-default Environment or namespace, or when you need to configure cloud providers during initialization. + +## Using `rad install` + +Use [`rad install kubernetes`]({{< ref rad_install_kubernetes >}}) to install the control plane. It installs the control plane, creates the default Resource Types, and creates a `default` Resource Group and Environment, but it does not create any local files. Optionally use the `--set` flag to customize the installation with [Helm chart options](#customizing-the-installation-with-helm-chart-options): + +```bash +# Install Radius +rad install kubernetes + +# Install Radius with tracing and a public endpoint override +rad install kubernetes --set global.zipkin.url=http://jaeger-collector.radius-monitoring.svc.cluster.local:9411/api/v2/spans,rp.publicEndpointOverride=localhost:8081 +``` + +### Use your own root certificate authority certificate + +Many enterprises leverage intermediate root certificate authorities (CAs) to enhance security and control over outgoing traffic, particularly when using a firewall or proxy. In this setup, when Radius attempts to connect to an external endpoint such as Azure or AWS, traffic may be blocked by the firewall. Optionally use `--set-file` when installing Radius to inject your root CA certificate into Radius: + +```bash +rad install kubernetes --set-file global.rootCA.cert=/etc/ssl/your-root-ca.crt +``` + +## Using Helm + +For full control over the installation, install Radius directly with Helm. The Radius chart is published as an [OCI artifact](https://helm.sh/docs/topics/registries/) to GitHub Container Registry (GHCR), so there is no Helm repository to add. + +Install the chart directly from its OCI registry: + +```bash +helm upgrade radius oci://ghcr.io/radius-project/helm-chart --install --create-namespace --namespace radius-system --version {{< param chart_version >}} --wait --timeout 15m0s +``` + +To install a different version, change the `--version` flag. Inspect the chart before installing with: + +```bash +helm show chart oci://ghcr.io/radius-project/helm-chart --version {{< param chart_version >}} +``` + +## Customizing the installation with Helm chart options + +Whether you install with `rad install kubernetes --set` or with Helm directly, the following chart options are available: + +| Name | Default | Description | +| --- | --- | --- | +| `global.zipkin.url` | | Zipkin collector URL. If not specified, tracing is disabled. | +| `global.prometheus.enabled` | `true` | Enables Prometheus metrics. Defaults to `true`. | +| `global.prometheus.path` | `"/metrics"` | Metrics endpoint. | +| `global.prometheus.port` | `9090` | Metrics port. | +| `global.rootCA.cert` | | Root CA certificate injected into Radius containers. Use `--set-file global.rootCA.cert=[cert file]`. | +| `rp.image` | `ghcr.io/radius-project/applications-rp` | Location of the Radius resource provider (RP) image. | +| `rp.tag` | `latest` | Tag of the Radius resource provider (RP) image. | +| `rp.publicEndpointOverride` | `""` | Public endpoint of the Kubernetes cluster. Overrides automatic public endpoint detection. | +| `de.image` | `ghcr.io/radius-project/deployment-engine` | Location of the Bicep deployment engine (DE) image. | +| `de.tag` | `latest` | Tag of the Bicep deployment engine (DE) image. | +| `ucp.image` | `ghcr.io/radius-project/ucpd` | Location of the universal control plane (UCP) image. | +| `ucp.tag` | `latest` | Tag of the universal control plane (UCP) image. | + +## Next steps + +Once the Radius control plane has been installed, Radius can be used to deploy applications to the Kubernetes cluster. In order to deploy resources to AWS or Azure, configure cloud providers. + +{{< button text="Next step: How to configure cloud provider credentials" page="installation/cloud-providers" >}} diff --git a/docs/content/installation/dashboard/_index.md b/docs/content/installation/dashboard/_index.md new file mode 100644 index 000000000..759314780 --- /dev/null +++ b/docs/content/installation/dashboard/_index.md @@ -0,0 +1,56 @@ +--- +type: docs +title: "How to configure access to the Radius dashboard" +linkTitle: "Access the Dashboard" +description: "Accessing the Radius dashboard" +weight: 400 +aliases: + - /guides/installation/dashboard/ +--- + +How you access the Dashboard depends on how Radius is installed. For local development on a k3d or kind cluster, port-forwarding is the simplest option. For centralized installations on a shared cluster such as AKS or EKS, a platform engineer typically configures ingress so that users can reach the Dashboard without port-forwarding. + +## Port-forwarding + +Create a port-forward from `localhost` to a port of your choice to access the Radius Dashboard, then visit [http://localhost:7007](http://localhost:7007) in a browser: + +```bash +kubectl port-forward --namespace=radius-system svc/dashboard 7007:80 +``` + +Port-forwarding works well on a local cluster like k3d or kind, where the cluster runs on your own machine and only you need access to the Dashboard. + +## Ingress + +For a centralized Radius installation on a shared cluster such as AKS or EKS, port-forwarding requires every user to have `kubectl` access to the `radius-system` namespace. Instead, a platform engineer can expose the Dashboard through the cluster's ingress controller so that users can reach it over a stable URL. + +The Dashboard is served by the `dashboard` service in the `radius-system` namespace on port `80`. Configure an ingress resource that routes to this service using whichever ingress controller your cluster uses (for example, NGINX, AKS Application Gateway, or AWS Load Balancer Controller). The following example uses the NGINX ingress controller: + +```yaml +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: dashboard + namespace: radius-system +spec: + ingressClassName: nginx + rules: + - host: dashboard.example.com + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: dashboard + port: + number: 80 +``` + +Update the `host`, `ingressClassName`, and any annotations to match your cluster and ingress controller. Because the Dashboard does not provide its own authentication, secure access to itβ€”for example with TLS and an authentication proxyβ€”before exposing it outside the cluster. + +## Next steps + +With the Dashboard configured, set up developer workstations so your team can build and deploy applications. + +{{< button text="Next step: How to set up developer workstations" page="installation/dev-workstation" >}} diff --git a/docs/content/installation/dev-workstation/_index.md b/docs/content/installation/dev-workstation/_index.md new file mode 100644 index 000000000..0098549b6 --- /dev/null +++ b/docs/content/installation/dev-workstation/_index.md @@ -0,0 +1,156 @@ +--- +type: docs +title: "How to set up developer workstations" +linkTitle: "Developer workstations" +description: "Learn how to set up a developer workstation for creating and deploying applications" +weight: 500 +aliases: + - /guides/installation/dev-workstation/ + - /guides/installation/vscode/ + - /guides/installation/vscode/overview/ + - /guides/installation/bicepconfig/ + - /guides/installation/dev-workstation#configure-bicepconfigjson/ +--- + +Setting up a developer workstation is very similar to [installing Radius]({{< ref "/installation" >}}) for the first time. The main difference is that Radius is already running in the Kubernetes cluster, so instead of installing the control plane, you point your workstation at the existing installation. This guide walks through setting up a workstation for authoring and deploying Radius applications, and how a platform team can prepare their developers' workstations at scale. + +## Install the Radius CLI + +The [Radius CLI]({{< ref "/installation/cli" >}}) (`rad`) is the primary tool for deploying and managing Radius applications. + +{{< read file="/shared-content/installation/rad-cli/install-rad-cli.md" >}} + +For more detail, including how to change the installation directory, see [Install the Radius CLI]({{< ref "/installation/cli#install-the-radius-cli" >}}). + +## Connect to your Radius installation + +The `rad` CLI talks to Radius through your current `kubectl` context, so make sure [`kubectl`](https://kubernetes.io/docs/tasks/tools/) is installed and its current context points at the Kubernetes cluster where Radius is installed: + +```bash +kubectl config current-context +``` + +From your application's directory, initialize Radius: + +```bash +rad initialize +``` + +Because Radius is already installed in the cluster, `rad initialize` does not install the control plane again. Instead, it: + +- Creates a Radius Workspace that points the `rad` CLI at your existing Radius installation. +- Writes a `bicepconfig.json` into the current directory so you can author Radius resource types in Bicep. + +Select `Yes` when prompted to set up the application in the current directory. + +## Distribute Bicep extensions to developers + +When you install Radius, via `rad install` or `rad initialize`, a set of out-of-the-box Resource Types are created along with a Bicep extension for each Resource Type. If additional Resource Types have been created in the Radius control plane, a new Bicep extension for those Resource Types must be created and distributed to each developer workstation so that everyone is using the same set of Resource Types. + +[`rad bicep publish-extension`]({{< ref rad_bicep_publish-extension >}}) compiles the Resource Types into a Bicep extension. Publish it to an Azure Container Registry (ACR) to share across a team, or write it to a local file for testing or for distributing alongside your application. + +{{< tabs "Azure Container Registry" "Local file" >}} + +{{% codetab %}} +Publish the extension to an ACR. You must be logged in to the registry (for example, with `docker login`) and have permission to push: + +```bash +rad bicep publish-extension \ + --from-file ./mycompany-radius-resources.yaml \ + --target br:mycompany.azurecr.io/radius-resources:v1 +``` + +{{% /codetab %}} + +{{% codetab %}} +Publish the extension to a local file for testing or for distributing alongside your application: + +```bash +rad bicep publish-extension \ + --from-file ./mycompany-radius-resources.yaml \ + --target ./mycompany-radius-resources.tgz +``` + +{{% /codetab %}} + +{{< /tabs >}} + +Once the extension is published, each developer references it from their `bicepconfig.json` as described in [Add custom resource types to bicepconfig.json](#configure-bicepconfigjson). + +## Add custom resource types to bicepconfig.json {#configure-bicepconfigjson} + +`rad initialize` generates a `bicepconfig.json` that includes the **`radius`** extension, which configures the Bicep extension for all out-of-the-box Resource Types. Bicep resolves this file from the same directory as your Bicep files, or the nearest parent directory. With the `radius` extension in place, you can deploy applications that use any of the out-of-the-box Resource Types: + +```json +{ + "extensions": { + "radius": "br:biceptypes.azurecr.io/radius:" + } +} +``` + +To author against Resource Types that your team has [published as a Bicep extension](#distribute-bicep-extensions-to-developers), add that extension to the `extensions` map alongside `radius`. Reference an ACR-published extension by its registry path, or a local extension by its path on disk: + +{{< tabs "Azure Container Registry" "Local file" >}} + +{{% codetab %}} + +```json +{ + "extensions": { + "radius": "br:biceptypes.azurecr.io/radius:", + "mycompany": "br:mycompany.azurecr.io/radius-resources:v1" + } +} +``` + +{{% /codetab %}} + +{{% codetab %}} + +```json +{ + "extensions": { + "radius": "br:biceptypes.azurecr.io/radius:", + "mycompany": "./mycompany-radius-resources.tgz" + } +} +``` + +{{% /codetab %}} + +{{< /tabs >}} + +With the extension referenced, developers can use the distributed types in their Bicep files: + +```bicep +extension radius +extension mycompany +``` + +Sharing a common `bicepconfig.json` keeps every developer on the same extension versions. + +## Install the Bicep extension for VS Code + +Radius applications are authored in [Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/overview). Visual Studio Code offers the best authoring experience, providing formatting, IntelliSense, and validation for Bicep templates and Radius resource types. + +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). + +## Create Kubernetes users and roles + +Radius runs on Kubernetes, so access to a Radius installation is governed by Kubernetes [role-based access control (RBAC)](https://kubernetes.io/docs/reference/access-authn-authz/rbac/). Platform engineers need the `cluster-admin` role to [install and upgrade Radius]({{< ref "/installation/control-plane" >}}), because those operations create cluster-scoped resources. Developers only need access to the Radius API. + +The following example `ClusterRole` grants minimal access to the Radius API (`api.ucp.dev`): + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: aggregator-cluster-role +rules: +- apiGroups: ["api.ucp.dev"] + resources: ["*"] + verbs: ["*"] +``` + +Bind this `ClusterRole` to each developer's user account with a `ClusterRoleBinding` so they can access the Radius API. diff --git a/docs/content/installation/uninstall/index.md b/docs/content/installation/uninstall/index.md new file mode 100644 index 000000000..01ed339ac --- /dev/null +++ b/docs/content/installation/uninstall/index.md @@ -0,0 +1,31 @@ +--- +type: docs +title: "How to uninstall Radius" +linkTitle: "Uninstall Radius" +description: "Learn how to uninstall the Radius control plane from your Kubernetes cluster" +weight: 700 +aliases: + - /guides/installation/control-plane/uninstall/ +--- + +Uninstalling Radius removes the Radius control plane from the Kubernetes cluster. You can choose whether to retain your Radius configuration and resource data or delete it entirely. + +## Retain resources + +To uninstall the Radius control plane while keeping your Radius configuration and data, run: + +```bash +rad uninstall kubernetes +``` + +All Radius services running in the `radius-system` namespace are removed, but Radius configuration and data remain persisted in the Kubernetes cluster. This lets you reinstall Radius later without losing your existing environments and applications. + +## Delete resources + +To completely remove Radius, including all configuration and data, delete the `radius-system` namespace after uninstalling: + +```bash +rad uninstall kubernetes --purge +``` + +All Radius configuration and data stored in the namespace is removed. This completely removes Radius from the cluster. diff --git a/docs/content/installation/upgrade/index.md b/docs/content/installation/upgrade/index.md new file mode 100644 index 000000000..f0760b820 --- /dev/null +++ b/docs/content/installation/upgrade/index.md @@ -0,0 +1,123 @@ +--- +type: docs +title: "How to upgrade Radius" +linkTitle: "Upgrade Radius" +description: "Learn how to upgrade Radius on Kubernetes, including how to roll back to a previous version" +weight: 600 +aliases: + - /guides/installation/control-plane/upgrade/ +--- + +Radius supports in-place upgrades on Kubernetes clusters using the `rad upgrade kubernetes` command. This command upgrades the Radius control plane while preserving your existing environments and applications. If an upgrade causes issues, you can roll back to a previous version. + +## Important considerations + +While Radius supports in-place upgrades, breaking changes may still occur between major versions. Always review the [release notes](https://github.com/radius-project/radius/releases) before upgrading to understand any breaking changes or migration steps required. + +## Step 1: Record the existing version + +Use the `rad version` command and record the existing version of the Radius CLI and control plane. In the example below, both the Radius CLI and control plane are running v0.58: + +```bash +# Check Radius version +$ rad version +CLI Version Information: +RELEASE VERSION BICEP COMMIT +0.58.0 v0.58.0 0.42.1 d8289818dc121527659b781707500a1c9d46c2fe + +Control Plane Information: +STATUS VERSION +Installed 0.58.0 +``` + +## Step 2: Upgrade the Radius CLI + +First, ensure you have the latest version of the Radius CLI: + +{{< read file="/shared-content/installation/rad-cli/install-rad-cli.md" >}} + +## Step 3: Upgrade the Radius control plane + +Use the [`rad upgrade kubernetes`]({{< ref rad_upgrade_kubernetes >}}) command to upgrade Radius in the cluster: + +```bash +# Upgrade to the latest version matching your CLI +rad upgrade kubernetes + +# Upgrade to a specific version +rad upgrade kubernetes --version 0.59.0 +``` + +### Preflight checks + +The upgrade process automatically runs preflight checks to ensure the cluster is ready for the upgrade. These checks include: + +- **Kubernetes connectivity and permissions**: Verifies connection to the cluster and required RBAC permissions +- **Helm connectivity and installation status**: Confirms Radius is installed via Helm and can be upgraded +- **Version compatibility validation**: Ensures the target version is compatible with your current version +- **Cluster resource availability**: Checks for sufficient resources (optional warning) +- **Custom configuration validation**: Validates any custom Helm values + +To skip preflight checks (not recommended): + +```bash +rad upgrade kubernetes --skip-preflight +``` + +To run only preflight checks without upgrading: + +```bash +rad upgrade kubernetes --preflight-only +``` + +## Step 4: Verify the upgrade + +After the upgrade completes, verify all Radius pods are running. + +```bash +# Verify pods are running +$ kubectl get pods -n radius-system +NAME READY STATUS RESTARTS AGE +applications-rp 1/1 Running 0 47s +bicep-de 1/1 Running 0 47s +controller 1/1 Running 0 47s +dashboard 1/1 Running 0 47s +dynamic-rp 1/1 Running 0 47s +ucp 1/1 Running 0 47s +``` + +Then verify that the Radius control plane is running the new version, v0.59 in this example: + +```bash +# Check Radius version +$ rad version +CLI Version Information: +RELEASE VERSION BICEP COMMIT +0.59.0 v0.59.0 0.42.1 2bf2c25fcdde20d4cba1371618829bbbe1f9a997 + +Control Plane Information: +STATUS VERSION +Installed 0.59.0 +``` + +## Rollback + +> **Warning:** Custom Resource Definitions (CRDs) are not automatically rolled back due to [Helm limitations](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/). If the newer version introduced CRD changes, rolling back the control plane might result in compatibility issues. In such cases, you may need to manually revert CRD changes or perform a fresh installation of the desired version. + +Radius supports rolling back to previous versions on Kubernetes clusters using the [`rad rollback kubernetes`]({{< ref rad_rollback_kubernetes >}}) command. This lets you quickly revert to a known-good version if issues are encountered after an upgrade. + +```bash +# Roll back to the previously installed version +rad rollback kubernetes +``` + +- **Environments and applications**: Preserved during rollback, as they are stored as Kubernetes resources. +- **Custom Helm values**: Previous configuration values are restored with the rollback. +- **Workspace configuration**: Local Workspace configuration (in `~/.rad`) is not affected by rollback. + +If the Radius CLI rollback fails, you can roll back using Helm directly: + +```bash +# Roll back to a specific revision, e.g. revision 2 +helm rollback radius 2 -n radius-system +``` diff --git a/docs/content/integrations/_index.md b/docs/content/integrations/_index.md new file mode 100644 index 000000000..f055374c3 --- /dev/null +++ b/docs/content/integrations/_index.md @@ -0,0 +1,9 @@ +--- +type: docs +title: "Integrations" +linkTitle: "Integrations" +description: "Deploy Radius Applications with Flux and use Dapr with Radius" +weight: 800 +--- + +Integrate Radius with Flux for GitOps deployments and with Dapr for sidecars and building blocks. diff --git a/docs/content/integrations/dapr/_index.md b/docs/content/integrations/dapr/_index.md new file mode 100644 index 000000000..2476b78dd --- /dev/null +++ b/docs/content/integrations/dapr/_index.md @@ -0,0 +1,141 @@ +--- +type: docs +title: "How to use Dapr and Radius together" +linkTitle: "Use Dapr with Radius" +description: "Learn how to configure Dapr sidecars and building blocks with Radius" +weight: 300 +aliases: + - /guides/dapr/ + - /guides/dapr/overview/ + - /guides/dapr/how-to-dapr-sidecar/ + - /guides/dapr/how-to-dapr-building-block/ + - /guides/dapr/how-to-dapr-secrets/ + - /guides/applications/dapr/ + - /guides/applications/dapr/overview/ + - /guides/applications/dapr/how-to-dapr-sidecar/ + - /guides/applications/dapr/how-to-dapr-building-block/ + - /guides/applications/dapr/how-to-dapr-secrets/ +--- + +Radius integrates with [Dapr](https://dapr.io/) by configuring Dapr sidecars on Containers and modeling Dapr building blocks as Radius resources. Radius deploys the Dapr components with the Application and adds them to the Application graph. + +This guide focuses on three independent integration patterns: configuring sidecars and building blocks, enabling service invocation, and referencing secrets from Dapr components. See the [Dapr documentation](https://docs.dapr.io/) for installing Dapr and using its APIs, SDKs, and building blocks. + +{{% alert title="Legacy Resource Types" color="warning" %}} +The Dapr integration uses the `Applications.Core`, `Applications.Dapr`, and `Applications.Datastores` Resource Types. These legacy Resource Types remain supported for this integration. Use current `Radius.*` Resource Types for applications that do not require these Dapr resources. +{{% /alert %}} + +## Configure a sidecar and building block + +The following example defines: + +- A Container with a Dapr sidecar. +- A Dapr state store named `statestore`. +- A connection from the Container to the state store. + +```bicep +extension radius + +@description('The Radius Application ID. Injected automatically by the rad CLI.') +param application string + +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string + +resource demo 'Applications.Core/containers@2023-10-01-preview' = { + name: 'demo' + properties: { + application: application + container: { + image: 'ghcr.io/radius-project/samples/demo:latest' + ports: { + web: { + containerPort: 3000 + } + } + } + extensions: [ + { + kind: 'daprSidecar' + appId: 'demo' + appPort: 3000 + } + ] + connections: { + redis: { + source: stateStore.id + } + } + } +} + +resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { + name: 'statestore' + properties: { + environment: environment + application: application + } +} +``` + +The `daprSidecar` extension configures Dapr for the Container: + +- `appId` is the Dapr application ID used for service invocation. +- `appPort` is the port where the application listens for requests from the sidecar. + +The `Applications.Dapr/stateStores` resource represents a Dapr state store component. The Recipe configured for this Resource Type provisions its backing infrastructure and creates the Dapr component. Radius includes the Container, sidecar configuration, state store, and Recipe-provisioned infrastructure in the same Application. + +### Use the component name + +The Dapr component name is the name of the Radius Dapr resource. In the example, the component name is `statestore`. + +The connection named `redis` makes the component name available to the Container in the `CONNECTION_REDIS_COMPONENTNAME` environment variable. Use a connection instead of duplicating the component name in the Container configuration. + +Application code can pass that component name to the appropriate [Dapr building block API or SDK](https://docs.dapr.io/developing-applications/building-blocks/). + +## Configure service invocation + +Set a unique `appId` on each Container's Dapr sidecar. A calling service uses the target Container's `appId` when invoking it through Dapr. + +In the sidecar example above, other services invoke the `demo` App ID through the [Dapr service invocation API or SDK](https://docs.dapr.io/developing-applications/building-blocks/service-invocation/). The calling Container also needs a Dapr sidecar, but it does not need a Radius connection to the target Container. + +## Reference secrets from a Dapr component + +For manually configured Dapr components, use `secretKeyRef` for sensitive metadata and select the Dapr secret store through `auth.secretStore`: + +```bicep +resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { + name: 'statestore' + properties: { + environment: environment + application: application + resourceProvisioning: 'manual' + type: 'state.redis' + version: 'v1' + auth: { + secretStore: secretStore.name + } + metadata: { + redisHost: { + value: 'redis.example.com:6379' + } + redisUsername: { + secretKeyRef: { + name: 'redis-auth' + key: 'username' + } + } + } + } +} + +resource secretStore 'Applications.Dapr/secretStores@2023-10-01-preview' = { + name: 'secretstore' + properties: { + environment: environment + application: application + } +} +``` + +The referenced secret must exist in the selected Dapr secret store. See the [Dapr secret store documentation](https://docs.dapr.io/operations/components/setup-secret-store/) for provider-specific configuration. diff --git a/docs/content/integrations/gitops/_index.md b/docs/content/integrations/gitops/_index.md new file mode 100644 index 000000000..f0207acb6 --- /dev/null +++ b/docs/content/integrations/gitops/_index.md @@ -0,0 +1,180 @@ +--- +type: docs +title: "How to deploy Applications using Flux" +linkTitle: "Deploy Applications with Flux" +description: "Learn how to deploy Applications with Flux and Radius integration" +weight: 100 +aliases: + - /guides/gitops/ + - /guides/gitops/overview/ + - /guides/gitops/howto-flux/ +--- + +Radius integrates with [Flux](https://fluxcd.io/) to continuously deploy and manage cloud-native Applications and infrastructure from a Git repository. The repository provides a version-controlled source of truth, while Flux detects changes and triggers Radius to reconcile the deployed resources with the desired state. + +This guide explains how the Radius integration works, how to configure a repository, and how to deploy and manage an existing Radius Application with Flux. + +## GitOps capabilities in Radius + +1. **Declarative configuration:** Store Bicep Application definitions, parameters, and Radius deployment configuration in Git so the desired state is version controlled and reviewable. +1. **Continuous deployment:** Flux detects new repository revisions, and Radius compiles and deploys the Bicep files selected in the repository configuration. +1. **Reconciliation:** Radius creates or updates a `DeploymentTemplate` for each configured Bicep file. Removing an entry from the configuration deletes its `DeploymentTemplate` and the resources managed by that deployment. +1. **Security and compliance:** Git history provides an auditable record of changes. Repository access, branch protection, and review policies remain managed through the Git provider and Flux. +1. **Scalability and flexibility:** A repository can define multiple deployments with separate Kubernetes namespaces and Radius Resource Groups. Multiple Flux `GitRepository` resources can target repositories for different clusters or deployment stages. + +## How Radius integrates with Flux + +The Radius controller watches Flux `GitRepository` resources in the Kubernetes cluster. When Flux publishes a new repository revision, Radius: + +1. Downloads the artifact from the Flux source controller. +1. Looks for `radius-gitops-config.yaml` at the root of the artifact. Repositories without this file are ignored by Radius. +1. Compiles each Bicep file listed in the configuration and applies its optional Bicep parameters. +1. Creates or updates a `DeploymentTemplate` in the configured Kubernetes namespace. +1. Deploys the template into the configured Radius Resource Group. +1. Deletes `DeploymentTemplate` resources previously created from the repository when their Bicep files are removed from the configuration. + +Flux manages access to and synchronization of the Git repository. Radius manages Bicep compilation and deployment after Flux produces a new artifact. + +## Before you begin + +Before deploying an Application with Flux, verify that: + +- The [Radius control plane]({{< ref "/installation/control-plane" >}}) is installed in the Kubernetes cluster. +- The [Flux control plane components](https://fluxcd.io/flux/installation/#install-the-flux-controllers) are installed in your Kubernetes cluster. +- The [Flux CLI](https://fluxcd.io/docs/installation/) is installed. +- The target [Radius Resource Group]({{< ref "/management/groups" >}}) exists. +- An existing Bicep file defines the Radius Application and resources to deploy. +- A remote Git repository, such as GitHub or GitLab, is available to store the deployment files. + +{{% alert title="⚠️ Flux Network Policy" color="warning" %}} +When installing Flux using the `flux bootstrap` or `flux install` commands, specify `--network-policy=false`, or configure the network policy to allow access from the `radius-system` namespace to the source controller. This access allows Radius to communicate with the Flux source controller and synchronize changes from your Git repository. + +For more information, see the [Flux network policy documentation](https://fluxcd.io/flux/installation/configuration/optional-components/#network-policies). +{{% /alert %}} + +## Step 1: Configure the repository + +Add the existing Bicep Application definition to the Git repository. Add a `.bicepparam` file when the deployment requires parameters, then create `radius-gitops-config.yaml` at the repository root: + +```text +. +β”œβ”€β”€ app.bicep +β”œβ”€β”€ app.bicepparam +└── radius-gitops-config.yaml +``` + +The following configuration deploys `app.bicep` with `app.bicepparam`, creates its `DeploymentTemplate` in the `app` Kubernetes namespace, and targets the `default` Radius Resource Group: + +```yaml +config: + - name: app.bicep + params: app.bicepparam + namespace: app + resourceGroup: default +``` + +Each entry under `config` supports these fields: + +| Field | Required | Description | +| --- | --- | --- | +| `name` | Yes | Path to a `.bicep` file in the repository. The file must exist. | +| `params` | No | Path to an existing `.bicepparam` file used to compile the Bicep file. | +| `namespace` | No | Kubernetes namespace for the generated `DeploymentTemplate`. Radius creates the namespace if needed. Defaults to the Bicep filename without `.bicep`. | +| `resourceGroup` | No | Radius Resource Group where the template deploys resources. Defaults to the Bicep filename without `.bicep`. The Resource Group must already exist. | + +Add another entry under `config` for each additional Bicep deployment. Specify `namespace` and `resourceGroup` explicitly when the filename-derived defaults do not match the intended deployment scope. + +Commit and push the deployment files: + +```bash +git add app.bicep app.bicepparam radius-gitops-config.yaml +git commit -m "Configure Radius deployment" +git push origin main +``` + +Omit `app.bicepparam` from the repository, configuration, and `git add` command when the Bicep file does not require parameters. + +## Step 2: Create a Flux GitRepository source + +Create a Flux `GitRepository` source for your repository: + +```bash +flux create source git radius-flux-app \ + --url= \ + --branch=main +``` + +Flux creates a `GitRepository` resource and begins polling the selected branch. For private repository authentication and other source options, see the [Flux GitRepository documentation](https://fluxcd.io/flux/components/source/gitrepositories/). + +## Step 3: Verify the deployment + +Check whether Flux has fetched the repository: + +```bash +flux get sources git radius-flux-app +``` + +Then inspect the `DeploymentTemplate` created by Radius: + +```bash +kubectl get deploymenttemplates -A +kubectl describe deploymenttemplate app.bicep -n app +``` + +A ready `DeploymentTemplate` indicates that Radius compiled the Bicep file and completed the deployment. Use [`rad app graph`]({{< ref rad_application_graph >}}) with the Application name declared in the Bicep file to inspect the resulting Application graph: + +```bash +rad app graph -a +``` + +## Step 4: Update a deployment + +Update the Bicep definition, its parameter file, or its entry in `radius-gitops-config.yaml`, then commit and push the change. Flux publishes the new revision, and Radius updates the corresponding `DeploymentTemplate` and deployed resources. + +## Remove a deployment + +Remove a Bicep entry from `radius-gitops-config.yaml` and push the change when Flux should stop managing that deployment. To remove every deployment associated with the repository, use an empty configuration: + +```yaml +config: [] +``` + +When Radius processes the revision, it deletes the `DeploymentTemplate` for each removed entry. The `DeploymentTemplate` controller deletes resources managed by those deployments. Review the affected resources before pushing the change. + +After the deployment is removed, delete unreferenced Bicep and parameter files from the repository if they are no longer needed. + +## Troubleshoot reconciliation + +Check each stage in order to isolate where reconciliation stopped: + +### Check the Flux source + +Confirm that Flux fetched the expected revision: + +```bash +flux get sources git radius-flux-app +kubectl describe gitrepository radius-flux-app -n flux-system +``` + +If Flux cannot fetch a private repository, review the `GitRepository` authentication and secret configuration in the [Flux documentation](https://fluxcd.io/flux/components/source/gitrepositories/#secret-reference). + +### Check the repository configuration + +Confirm that `radius-gitops-config.yaml` is at the repository root and that every `name` and `params` path refers to an existing file. Radius ignores a repository without the configuration file and rejects entries with missing files or a `name` that does not end in `.bicep`. + +### Check the DeploymentTemplate + +Inspect the generated `DeploymentTemplate` status and Kubernetes events: + +```bash +kubectl get deploymenttemplates -A +kubectl describe deploymenttemplate app.bicep -n app +``` + +### Check the Radius controller + +Inspect the Radius controller logs for configuration parsing, Bicep compilation, or deployment errors: + +```bash +kubectl logs -n radius-system deployment/controller +``` diff --git a/docs/content/integrations/routes/index.md b/docs/content/integrations/routes/index.md new file mode 100644 index 000000000..4020454da --- /dev/null +++ b/docs/content/integrations/routes/index.md @@ -0,0 +1,189 @@ +--- +type: docs +title: "How to use the Kubernetes Gateway API with Radius" +linkTitle: "Use the Gateway API with Radius" +description: "Learn how the Routes Resource Type integrates with the Kubernetes Gateway API and third-party gateway controllers" +weight: 200 +aliases: + - /guides/routes/ +--- + +The [Routes]({{< ref "/reference/resources" >}}) Resource Type exposes your application's Containers to external connections. It builds on the [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/) and works with any conformant gateway controller such as NGINX Gateway Fabric, Envoy Gateway, Istio, or Contour. A Routes resource is analogous to a Kubernetes `HTTPRoute`, `TCPRoute`, `TLSRoute`, or `UDPRoute`. + +Radius does not install or manage a gateway. You install a gateway controller and create a gateway in your cluster, then configure the Routes recipe to use that gateway. This guide covers installing a controller, configuring the recipe with your gateway's name, and adding a route to your application. + +## How the integration works + +A Routes resource declares how external traffic reaches your application, such as which path forwards to which container. When Radius provisions it, the Routes recipe creates the matching Gateway API route (an `HTTPRoute`, for example) and attaches it to a gateway that already exists in your cluster. + +Radius relies on two things you set up outside of it: + +- **A gateway controller and gateway** running in the cluster. +- **The gateway's name and namespace**, which you pass to the Routes recipe through the `gatewayName` and `gatewayNamespace` parameters on the Recipe Pack or the Environment. + +Because the recipe finds the gateway by name, the same application definition works across clusters that run different gateway controllers. + +## Step 1: Install a gateway controller + +Install the [Gateway API](https://gateway-api.sigs.k8s.io/) CRDs and a conformant controller, then create a gateway for Radius routes to attach to. The following example uses [NGINX Gateway Fabric](https://docs.nginx.com/nginx-gateway-fabric/); any conformant controller works. + +Install the Gateway API CRDs and the controller. Use the versions and commands from your controller's installation guide: + +```bash +# Install the standard Gateway API CRDs +kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.2.1/standard-install.yaml + +# Install a gateway controller (NGINX Gateway Fabric shown here) +helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric \ + --create-namespace --namespace nginx-gateway +``` + +Create a `Gateway` that the Routes recipe attaches to. This example defines a gateway named `radius-gateway` in the `nginx-gateway` namespace with an HTTP listener: + +```yaml +apiVersion: gateway.networking.k8s.io/v1 +kind: Gateway +metadata: + name: radius-gateway + namespace: nginx-gateway +spec: + gatewayClassName: nginx + listeners: + - name: http + protocol: HTTP + port: 80 + allowedRoutes: + namespaces: + from: All +``` + +Apply it with `kubectl apply -f gateway.yaml`. Refer to your controller's documentation for TLS, load balancer, and DNS configuration. + +## Step 2: Point the Routes recipe at your gateway + +The Routes recipe attaches routes to the gateway you created. Provide the gateway name and namespace through the `gatewayName` and `gatewayNamespace` recipe parameters. Set them on the Recipe Pack so every Environment that references the pack shares the same gateway, or set them on an Environment to override the value per Environment. + +Set the parameters on the Recipe Pack: + +```bicep +extension radius + +resource computeRecipes 'Radius.Core/recipePacks@2025-08-01-preview' = { + name: 'compute-recipes' + properties: { + recipes: { + 'Radius.Compute/routes': { + kind: 'bicep' + source: 'ghcr.io/my-org/recipes/routes:v1.0.0' // Replace with your published Radius.Compute/routes recipe + parameters: { + gatewayName: 'radius-gateway' + gatewayNamespace: 'nginx-gateway' + } + } + } + } +} +``` + +Or set them on an Environment with `recipeParameters`, keyed by the Resource Type. A value set on the Environment overrides the value from the Recipe Pack: + +```bicep +resource devEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'dev' + properties: { + providers: { + kubernetes: { + namespace: 'dev' + } + } + recipePacks: [ + computeRecipes.id + ] + recipeParameters: { + 'Radius.Compute/routes': { + gatewayName: 'radius-gateway' + gatewayNamespace: 'nginx-gateway' + } + } + } +} +``` + +See [How to manage Recipe Packs]({{< ref "/extensibility/recipe-packs" >}}) and [How to design and manage Environments]({{< ref "/management/environments" >}}) for more on assigning recipes and setting parameters. + +## Step 3: Add a route to your application + +In your application definition, add a `Radius.Compute/routes` resource that forwards traffic to a Container. Each rule matches incoming requests and forwards them to a Container using its resource ID, container name, and port. The following example exposes the `frontend` Container's `web` port at the root path: + +```bicep +extension radius + +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string + +resource app 'Radius.Core/applications@2025-08-01-preview' = { + name: 'my-app' + properties: { + environment: environment + } +} + +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: app.id + containers: { + web: { + image: 'ghcr.io/radius-project/samples/demo:latest' + ports: { + web: { + containerPort: 3000 + } + } + } + } + } +} + +resource route 'Radius.Compute/routes@2025-08-01-preview' = { + name: 'frontend-route' + properties: { + environment: environment + application: app.id + kind: 'HTTP' + rules: [ + { + matches: [ + { + httpPath: '/' + } + ] + destinationContainer: { + resourceId: frontend.id + containerName: 'web' + containerPort: 3000 + } + } + ] + } +} +``` + +Set `kind` to `HTTP`, `TCP`, `TLS`, or `UDP` to select the kind of route. Use `matches` to route by path, header, method, or query parameter, and add more entries to `rules` to expose several Containers through the same gateway. For HTTP and TLS routes, set `hostnames` to match requests by host. See the [`Radius.Compute/routes` reference]({{< ref "/reference/resources" >}}), or run `rad resource-type show Radius.Compute/routes`, for the full property list. + +## Step 4: Deploy and access the application + +Deploy the definition with [`rad deploy`]({{< ref rad_deploy >}}): + +```bash +rad deploy app.bicep +``` + +Radius provisions the route, and its recipe creates the matching Gateway API route object attached to your gateway. The route's read-only `listener` property reports the hostname and port the recipe assigned. Inspect it with [`rad resource show`]({{< ref rad_resource_show >}}): + +```bash +rad resource show Radius.Compute/routes frontend-route +``` + +Send traffic to your gateway's external address using the reported hostname to reach the application. diff --git a/docs/content/management/_index.md b/docs/content/management/_index.md new file mode 100644 index 000000000..56dbfc702 --- /dev/null +++ b/docs/content/management/_index.md @@ -0,0 +1,9 @@ +--- +type: docs +title: "Manage Radius" +linkTitle: "Manage Radius" +description: "Manage Resource Groups, Environments, and Workspaces" +weight: 500 +--- + +Use Resource Groups, Environments, and Workspaces to organize resources, configure deployment targets, and save frequently used Radius contexts. diff --git a/docs/content/management/environments/_index.md b/docs/content/management/environments/_index.md new file mode 100644 index 000000000..1e2f55b26 --- /dev/null +++ b/docs/content/management/environments/_index.md @@ -0,0 +1,204 @@ +--- +type: docs +title: "How to design and manage Environments" +linkTitle: "Manage Environments" +description: "Learn how to design an Environment layout and manage Environments with the Radius CLI and Bicep" +weight: 200 +aliases: + - /guides/environments/ + - /guides/environments/manage-environments/ + - /guides/environments/environments/ + - /guides/environments/environments/howto-environment/ +--- + +Environments are prepared landing zones that define where applications deploy and how their resources are provisioned. Every Radius Application targets one Environment, but the Application and Environment do not need to belong to the same Resource Group. + +This guide explains how to design an Environment layout, create and target an Environment, and manage its configuration. For more background, see the [Environments concepts documentation]({{< ref "concepts/environments" >}}). + +## Design an Environment layout + +Use Environments to represent meaningful differences in deployment configuration. Common layouts include: + +- **Default Environment:** Use the `default` Environment created by `rad initialize`. This is the simplest layout for evaluating Radius, local development, or a small installation with one deployment target. +- **Lifecycle-based:** Create Environments such as `dev`, `test`, and `prod`. Each Environment must use a different Kubernetes namespace and can use different cloud provider accounts, Recipe Packs, and recipe parameters. +- **Location-based:** Create Environments for regions or clusters, such as `east-us` and `west-us`, when deployment location is the primary difference. +- **Team- or application-based:** Create dedicated Environments when teams or applications require different deployment targets, Recipe Packs, or platform policies. + +Create a new Environment when applications need different deployment destinations or provisioning behavior. Avoid creating an Environment only to separate resource names or ownership; use [Resource Groups]({{< ref "/management/groups" >}}) for those boundaries. + +### Plan Environment configuration + +An Environment brings together four areas of configuration: + +- **Cloud providers (`providers`)** select the Kubernetes namespace and the AWS or Azure account details where resources are deployed. Cloud provider credentials are registered separately with [`rad credential register`]({{< ref rad_credential_register >}}). +- **Recipe Packs** select the recipes used to provision infrastructure for Radius Resource Types. +- **Recipe parameters** override Recipe Pack defaults for a Resource Type across the Environment. The available parameters are defined by each recipe. +- **Bicep and Terraform settings** configure the infrastructure engines, including authentication for private module sources. + +An Environment is a deployment target, not a resource naming scope. Applications deployed to different Environments can still conflict when they have the same name, Resource Type, and Resource Group. See [How to design and manage Resource Groups]({{< ref "/management/groups#plan-resource-names" >}}) for naming guidance. + +{{% alert title="Kubernetes namespace uniqueness" color="warning" %}} +A Kubernetes namespace can be assigned to only one Environment in a Radius installation. Creating an Environment fails if another Environment already uses the namespace, even when the Environments belong to different Resource Groups. +{{% /alert %}} + +## Create an Environment + +Create the Resource Group first if it does not exist: + +```bash +rad group create dev +``` + +Run [`rad environment create`]({{< ref rad_environment_create >}}) to create a `dev` Environment in the `dev` Resource Group. The Kubernetes cloud provider deploys workloads into the `dev` namespace: + + +```bash +rad environment create dev \ + --group dev \ + --kubernetes-namespace dev \ + --preview +``` + +`rad environment create` assigns the `default` Recipe Pack from the `default` Resource Group to the new Environment. Use `rad environment update` after creation to select a different Recipe Pack. + +Confirm that the Environment exists with [`rad environment show`]({{< ref rad_environment_show >}}): + + +```bash +rad environment show dev --group dev --preview +``` + +## Target the Environment + +Pass `--environment` (or `-e`) and `--group` (or `-g`) to deploy an application to a specific Environment and Resource Group: + +```bash +rad deploy app.bicep --environment dev --group dev +``` + +The Environment controls how and where the application resources are deployed. The Resource Group controls the scope within the Radius control plane where resources are stored and named. + +Specifying both flags makes the target explicit and is useful in scripts and automation. + +## Update an Environment + +Use [`rad environment update`]({{< ref rad_environment_update >}}) to update cloud provider configuration. For example, add or replace the AWS cloud provider on `dev`: + + +```bash +rad environment update dev \ + --group dev \ + --aws-account-id 123456789012 \ + --aws-region us-west-2 \ + --preview +``` + +The CLI can update cloud provider configuration and, in preview, the Recipe Pack list. Manage advanced properties declaratively in Bicep. Review changes to an Environment carefully because they affect subsequent deployments that target it. + +For example, after deploying the `data-recipes` Recipe Pack defined above into the `dev` Resource Group, replace the Environment's `default` Recipe Pack with `data-recipes`: + + +```bash +rad environment update dev \ + --group dev \ + --recipe-packs data-recipes \ + --preview +``` + +`--recipe-packs` replaces the complete Recipe Pack list; it does not append to it. Include every Recipe Pack the Environment should continue to use each time you run the command. To assign a Recipe Pack stored in a different Resource Group, see [Reference a Recipe Pack across Resource Groups](#reference-a-recipe-pack-across-resource-groups). + +## Reference a Recipe Pack across Resource Groups + +When you use `--group`, a Recipe Pack name resolves in that Resource Group. To assign a Recipe Pack from another Resource Group, pass its full Radius resource ID. + +For example, configure the `production` Environment in the `production` Resource Group to use `data-recipes` from the `default` Resource Group: + + +```bash +rad environment update production \ + --group production \ + --recipe-packs /planes/radius/local/resourceGroups/default/providers/Radius.Core/recipePacks/data-recipes \ + --preview +``` + +You can combine names and full resource IDs in a comma-separated list when an Environment uses multiple Recipe Packs: + +```bash +rad environment update production \ + --group production \ + --recipe-packs production-recipes,/planes/radius/local/resourceGroups/default/providers/Radius.Core/recipePacks/data-recipes \ + --preview +``` + +The `production-recipes` name resolves in the `production` Resource Group selected by `--group`, while the full resource ID selects `data-recipes` from `default`. Ensure that the selected Recipe Packs do not define recipes for the same Resource Type. + +## Delete an Environment + +Run [`rad environment delete`]({{< ref rad_environment_delete >}}) when the Environment is no longer needed: + + +```bash +rad environment delete dev --group dev --preview +``` + +The command prompts for confirmation. Verify that applications no longer target the Environment before deleting it. + +## Define advanced configuration with Bicep + +Use `Radius.Core` resources when an Environment needs Recipe Packs, recipe parameters, or settings that are easier to manage declaratively. The following example creates a `data-recipes` Recipe Pack and configures the Environment to use it: + +```bicep +extension radius + +resource devEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'dev' + properties: { + providers: { + kubernetes: { + namespace: 'dev' + } + } + recipePacks: [ + dataRecipes.id + ] + // Keys are Radius Resource Types. Values are parameters defined by that type's Recipe. + recipeParameters: { + 'Radius.Data/postgreSqlDatabases': { + sku: 'development' + } + } + } +} + +resource dataRecipes 'Radius.Core/recipePacks@2025-08-01-preview' existing = { + name: 'data-recipes' +} +``` + +Deploy the Environment definition into its Resource Group: + +```bash +rad deploy environment.bicep --group dev +``` + +See the [`Radius.Core/environments` reference]({{< ref "/reference/resources/radius.core/2025-08-01-preview/environments" >}}) for all supported properties. See the [cloud provider guides]({{< ref "/installation/cloud-providers" >}}) before configuring AWS or Azure cloud providers. + +## Configure TerraformSettings and BicepSettings + +Use `Radius.Core/terraformSettings` and `Radius.Core/bicepSettings` resources to configure the infrastructure engines that run recipes. These resources are separate from an Environment, so you can define the settings once and reference them from each Environment that needs the same configuration. + +Use **BicepSettings** when Bicep recipes pull templates from a private OCI registry. The settings map registry hostnames to authentication configuration. Reference the BicepSettings resource ID from the Environment's `bicepSettings` property, and Radius applies the authentication whenever a Bicep recipe pulls from a matching registry. See the [`Radius.Core/bicepSettings` reference]({{< ref "/reference/resources/radius.core/2025-08-01-preview/bicepsettings" >}}) for an example that configures private registry authentication and attaches it to an Environment. + +Use **TerraformSettings** to configure the Terraform CLI that runs Terraform recipes. Common use cases include: + +- Authenticating to a private Terraform registry with a token stored in a Radius Secret. +- Installing Terraform providers from an internal network mirror, including in air-gapped environments. +- Setting environment variables for Terraform CLI behavior or troubleshooting. + +Reference the TerraformSettings resource ID from the Environment's `terraformSettings` property. Radius applies the configuration to every Terraform recipe run in that Environment. Registry credentials configured in TerraformSettings authenticate Terraform CLI registries; they do not authenticate Git-based module sources. See the [`Radius.Core/terraformSettings` reference]({{< ref "/reference/resources/radius.core/2025-08-01-preview/terraformsettings" >}}) for private registry, provider mirror, environment variable, and Environment reference examples. + +## Next steps + +For installations with multiple control planes, Resource Groups, and Environments, use Workspaces to save them as named targets and use the Radius CLI without passing `--group` and `--environment` to every command. + +{{< button text="Next step: How to manage Workspaces" page="/management/workspaces" >}} diff --git a/docs/content/management/groups/index.md b/docs/content/management/groups/index.md new file mode 100644 index 000000000..91966feea --- /dev/null +++ b/docs/content/management/groups/index.md @@ -0,0 +1,110 @@ +--- +type: docs +title: "How to design and manage Resource Groups" +linkTitle: "Manage Resource Groups" +description: "Learn how to design a Resource Group layout and use Resource Groups with the Radius CLI" +weight: 100 +aliases: + - /guides/groups/ + - /guides/environments/groups/ + - /guides/environments/groups/overview/ + - /guides/environments/groups/howto-resourcegroups/ +--- + +Resource Groups organize Radius resources into scopes that can be managed independently. They are analogous to, but distinct from, Kubernetes namespaces and Azure resource groups. Every Radius resource belongs to exactly one Resource Group. Today, Resource Groups only hold resources. In the future, Resource Groups will be extended to implement Radius role-based access controls. + +This guide explains how to design a Resource Group layout, create a group, and target it with Radius CLI commands. For more background, see [Resource Groups in the Radius concepts documentation]({{< ref "concepts#resource-groups" >}}). + +## Design a Resource Group layout + +Use Resource Groups to collect resources that share a lifecycle, owner, or deployment boundary. Common layouts include: + +- **Default Resource Group:** Keep all resources in the `default` Resource Group created upon Radius installation. This is the simplest layout for evaluating Radius, local development, or a small installation managed by one team. Create additional groups when resources need separate names, lifecycles, or ownership. +- **Environment-based:** Create separate groups such as `dev`, `test`, and `prod`. This lets applications use the same names in each deployment stage because each Resource Group provides a separate naming scope. +- **Application-based:** Create one group per application or service. This reduces naming conflicts and lets each application lifecycle remain independent. +- **Team-based:** Create groups for teams or business units. This works well when a team owns several applications and shared resources. + +Choose a layout that keeps resources which are created, updated, and deleted together in the same group. Avoid putting every resource in one large group as the installation grows; broad groups increase the chance of naming collisions and make ownership less clear. + +### Plan resource names + +A resource name must be unique within its Resource Group and resource type. The Environment does not form part of the resource's naming scope. For example, a Resource Group cannot contain two `Radius.Core/applications` resources named `api`, even when one is deployed to the `dev` Environment and the other to `test`. The name `api` can be reused for a different resource type or in another Resource Group. See [Radius resource IDs]({{< ref "/reference/api/resource-ids#resource-name" >}}) for details. + +If multiple Environments share a Resource Group, account for the Environment in the application definition. For example, parameterize the application name in Bicep: + +```bicep +param environment string + +// environment is a resource ID ending in /providers/Radius.Core/environments/{name}. +var environmentName = last(split(environment, '/')) + +resource app 'Radius.Core/applications@2025-08-01-preview' = { + name: 'api-${environmentName}' + properties: { + environment: environment + } +} +``` + +Deploying to Environments named `dev` and `test` creates applications named `api-dev` and `api-test`. Alternatively, place each Environment's resources in a separate Resource Group so the application can be named `api` in both groups. + +Use a consistent naming convention that identifies the owner or purpose of a resource. If several teams share a Resource Group, include an application or team identifier in names to prevent collisions. + +### Radius Resource Groups and Azure resource groups + +Radius Resource Groups and Azure resource groups are separate concepts: + +- A **Radius Resource Group** organizes resources stored and managed by the Radius control plane, including applications, Environments, and Radius resource types. +- An **Azure resource group** organizes resources in an Azure subscription. + +Creating a Radius Resource Group does not create an Azure resource group. The Azure subscription and resource group used for Azure deployments are configured through the Azure cloud provider on a Radius Environment. A Radius Resource Group and an Azure resource group can have different names and lifecycles. + +## Create a Resource Group + +Run [`rad group create`]({{< ref rad_group_create >}}) to create a group in the current Radius control plane: + +```bash +rad group create myGroup +``` + +Confirm that the group exists with [`rad group show`]({{< ref rad_group_show >}}): + +```bash +rad group show myGroup +``` + +## Target the Resource Group + +Pass `--group` (or `-g`) to run a command against a specific Resource Group. For example, deploy `app.bicep` into `myGroup`: + +```bash +rad deploy app.bicep --group myGroup +``` + +The flag is also available on other group-scoped commands. For example, list resources in `myGroup`: + +```bash +rad resource list --group myGroup +``` + +Specifying `--group` makes the target explicit and is useful in scripts and automation. + +## Delete a Resource Group + +Run [`rad group delete`]({{< ref rad_group_delete >}}) when the group and all resources in it are no longer needed: + +```bash +rad group delete myGroup +``` + +The command shows a confirmation prompt and deletes resources in the group before deleting the group. Review the resources carefully because this operation affects the entire Resource Group. + +## Manage advanced layouts with Workspaces + +For installations with multiple Resource Groups and Environments, use Workspaces to save the control plane, Resource Group, and Environment as a named target. See [How to manage Workspaces]({{< ref "/management/workspaces" >}}) to create and switch between targets without passing `--group` and `--environment` to every command. + +## Next steps + +Now that Resource Groups have been created, learn how to manage Environments. + +{{< button text="Next step: How to manage Environments" page="/management/environments" >}} diff --git a/docs/content/management/workspaces/index.md b/docs/content/management/workspaces/index.md new file mode 100644 index 000000000..2b9ee82aa --- /dev/null +++ b/docs/content/management/workspaces/index.md @@ -0,0 +1,105 @@ +--- +type: docs +title: "How to manage Workspaces" +linkTitle: "Manage Workspaces" +description: "Use Workspaces to connect the Radius CLI to a control plane, Resource Group, and Environment" +weight: 300 +aliases: + - /guides/workspaces/ + - /guides/installation/workspaces/ + - /guides/environments/workspaces/howto-workspaces/ + - /guides/environments/workspaces/overview/ +--- + +A [Workspace]({{< ref "/reference/cli#local-workspace-config" >}}) is a named shortcut that connects the Radius CLI to a specific Radius control plane, selecting the `kubectl` context used to reach it along with the [Radius Resource Group]({{< ref "concepts#platform-engineer-components" >}}) and [Environment]({{< ref "concepts/environments" >}}) that `rad` commands target. + +Workspaces are optional, but they save you from specifying the Resource Group and Environment on every `rad` command. When you install Radius with `rad initialize`, a Workspace named `default` is configured automatically, targeting the `default` Resource Group and `default` Environment. Most commands operate against the current Workspace, and you can switch between Workspaces or target a specific Workspace on a single command. + +This guide explains how to create, inspect, select, replace, and delete Workspaces. For the configuration file format and storage location, see the [local Workspace configuration reference]({{< ref "/reference/cli#local-workspace-config" >}}). + +## Before you begin + +Before creating a Workspace, verify that: + +- The [Radius control plane]({{< ref "/installation/control-plane" >}}) is installed and reachable through a context in your kubeconfig. +- The target [Resource Group]({{< ref "/management/groups" >}}) and [Environment]({{< ref "/management/environments" >}}) already exist on that control plane. + +## Step 1: Create a Workspace + +Use [`rad workspace create`]({{< ref rad_workspace_create >}}) to save a Kubernetes context, Resource Group, and Environment as a named Workspace: + + +```bash +rad workspace create kubernetes my-workspace \ + --context my-context \ + --group my-group \ + --environment my-environment \ + --preview +``` + +The `--context` flag selects the Kubernetes context used to reach the Radius control plane. The `--group` and `--environment` flags set the default Resource Group and Environment for commands using the Workspace. Omit both defaults to select only the control plane, or omit `--environment` to select the control plane and Resource Group without a default Environment. + +Most `rad` commands do not accept a Kubernetes context directly. To run commands against a specific context without changing the active `kubectl` context, create a Workspace for that context and pass its name through `--workspace`. + +Creating a Workspace makes it the current Workspace. + +## Step 2: List and inspect Workspaces + +Use [`rad workspace list`]({{< ref rad_workspace_list >}}) to display the saved Workspaces and identify the current one: + +```bash +rad workspace list +``` + +Inspect the current Workspace or a named Workspace with [`rad workspace show`]({{< ref rad_workspace_show >}}): + +```bash +rad workspace show +rad workspace show --workspace my-workspace +``` + +## Step 3: Switch the current Workspace + +The current Workspace is the default target for `rad` commands. Use [`rad workspace switch`]({{< ref rad_workspace_switch >}}) to select another Workspace: + +```bash +rad workspace switch my-workspace +``` + +Confirm the selection with `rad workspace show`. Subsequent commands use the selected control plane, Resource Group, and Environment unless the command overrides them. + +## Step 4: Target a Workspace for one command + +To use a different Workspace without changing the current one, pass `--workspace` (or `-w`) to the command: + +```bash +rad deploy ./app.bicep --workspace my-workspace +``` + +This selects the Workspace's control plane, Resource Group, and Environment for that command only. + +## Step 5: Replace a Workspace + +To change a Workspace's context, Resource Group, or Environment, rerun `rad workspace create` with the same name and `--force`: + + +```bash +rad workspace create kubernetes my-workspace \ + --context another-context \ + --group another-group \ + --environment another-environment \ + --force \ + --preview +``` + +The replacement becomes the current Workspace. Specify every value the updated Workspace should retain. + +## Step 6: Delete a Workspace + +Delete a saved target with [`rad workspace delete`]({{< ref rad_workspace_delete >}}): + +```bash +rad workspace delete my-workspace +``` + +Deleting a Workspace removes only its local configuration. It does not delete the Radius control plane, Resource Group, Environment, or deployed resources. Use `--yes` to skip the confirmation prompt. diff --git a/docs/content/quick-start/index.md b/docs/content/quick-start/index.md index f84a71484..ccff9d6e6 100644 --- a/docs/content/quick-start/index.md +++ b/docs/content/quick-start/index.md @@ -2,7 +2,7 @@ type: docs title: "Quick Start: Deploy a containerized application" linkTitle: "Quick Start" -weight: 10 +weight: 100 description: "Perform a quick installation of Radius and deploy your first application" aliases: - /getting-started/ @@ -16,11 +16,11 @@ This guide will show you how to quickly get started with Radius. You will do a b ## Prerequisites -For this quick start, you will only need a **Kubernetes cluster**. To install Radius your user must have the cluster-admin role. Radius supports AKS, EKS, k3d, and kind clusters. For this quick start, running a Kubernetes cluster on your workstation with k3d or kind is recommended. +For this quick start, you will only need a **Kubernetes cluster**. To install Radius, your user must have the cluster-admin role. Radius }}">supports AKS, EKS, k3d, and kind clusters. For this quick start, running a Kubernetes cluster on your workstation with k3d or kind is recommended. ## Install the Radius CLI -{{< read file= "/shared-content/installation/rad-cli/install-rad-cli.md" >}} +{{< read file="/shared-content/installation/rad-cli/install-rad-cli.md" >}} ## Install Radius @@ -31,13 +31,13 @@ mkdir todolist cd todolist ``` -Ensure your cluster is set as your current context using `kubectl config current-context`. If the context needs updating, change it using `kubectl config set-context `. Then install Radius using `rad initialize` command: +Ensure your cluster is set as your current context using `kubectl config current-context`. If the context needs updating, change it using `kubectl config set-context `. Then install Radius using the `rad initialize` command: ```bash -rad initialize +rad initialize --preview ``` -Select `Yes` to set up application in the current directory. +Select `Yes` to set up an application in the current directory. Example output: @@ -49,32 +49,42 @@ Initializing Radius... - Kubernetes namespace: radius-system βœ… Create new environment default - Kubernetes namespace: default - - Recipe pack: local-dev + - Recipe pack: default recipe pack βœ… Scaffold application todolist βœ… Update local configuration Initialization complete! Have a RAD time 😎 ``` -## Run the Todo List Application +## Deploy the Todo List application In addition to installing Radius, the `rad initialize` command creates a sample application definition, `app.bicep`: ``` extension radius -@description('The Radius Application ID. Injected automatically by the rad CLI.') -param application string +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string -resource demo 'Applications.Core/containers@2023-10-01-preview' = { - name: 'demo' +resource todolist 'Radius.Core/applications@2025-08-01-preview' = { + name: 'todolist' properties: { - application: application - container: { - image: 'ghcr.io/radius-project/samples/demo:latest' - ports: { - web: { - containerPort: 3000 + environment: environment + } +} + +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: todolist.id + containers: { + web: { + image: 'ghcr.io/radius-project/samples/demo:latest' + ports: { + web: { + containerPort: 3000 + } } } } @@ -82,34 +92,59 @@ resource demo 'Applications.Core/containers@2023-10-01-preview' = { } ``` -Use the `rad run` command to deploy the application and setup port forwarding. +Use the `rad deploy` command to deploy the application to your Radius environment. + +```bash +rad deploy app.bicep +``` + +The `rad deploy` command deploys the Todo List sample application to the `default` Radius Environment which is configured to use the `default` namespace of your Kubernetes cluster. The `Radius.Compute/containers` resource in the application definition is provisioned using a Recipe which creates a Kubernetes Deployment and a `ClusterIP` Service. + +You can view the deployed resources using `kubectl`: ```bash -rad run app.bicep +kubectl get deployment,service +``` + +Example output: + +``` +NAME READY UP-TO-DATE AVAILABLE AGE +deployment.apps/frontend 1/1 1 1 6m55s + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/frontend-web ClusterIP 10.96.166.208 3000/TCP 6m55s ``` -This command: +## Browse the Todo List application UI -- Creates a Deployment on the Kubernetes cluster -- Since a containerPort was specified, creates a ClusterIP Service on the Kubernetes cluster -- Sets up port forwarding from localhost to the container -- Sets up port forwarding from localhost to the Radius Dashboard -- Streams container logs to your terminal +In order to access the Todo List application, use `kubectl` to forward a local port to the container's Kubernetes Service. + +```bash +kubectl port-forward svc/frontend-web 3000:3000 +``` -## Browse the Todo List Application UI +Browse to the Todo List application by opening [http://localhost:3000](http://localhost:3000) in your browser. Notice that the Radius Connections section says "No connections defined." In the five-part tutorial, you will add a database and a connection between the container and the database. -Browse to the Todo List application by visiting [http://localhost:3000](http://localhost:3000). Notice that the Radius Connections section says "No connections defined." In the five part tutorial, you will add a database and a connection between the container and the database. +Back in your terminal, press `Ctrl+C` to exit the port forwarding. ## Browse the Radius Dashboard -Browse to the Radius Dashboard by visiting [http://localhost:7007](http://localhost:7007). Find the Todo List Application under the Applications tab and examine its resources. +Start port forwarding for the Radius Dashboard: + +```bash +kubectl port-forward svc/dashboard 7007:80 -n radius-system +``` + +Open [http://localhost:7007](http://localhost:7007) in your browser. Find the Todo List application under the Applications tab and examine its resources. Press `Ctrl+C` to exit the port forwarding in your terminal when you are done. + ## View the Application Graph -The `rad app graph` command shows you all the resources that the application is composed of. +The `rad application graph` command shows you all the resources that the application is composed of. ```bash -rad app graph +rad application graph todolist --preview ``` You should see the following output, which lists the underlying Kubernetes resources running the application. @@ -117,14 +152,11 @@ You should see the following output, which lists the underlying Kubernetes resou ``` Displaying application: todolist -Name: demo (Applications.Core/containers) +Name: frontend (Radius.Compute/containers) Connections: (none) Resources: - demo (apps/Deployment) - demo (core/Service) - demo (core/ServiceAccount) - demo (rbac.authorization.k8s.io/Role) - demo (rbac.authorization.k8s.io/RoleBinding) + frontend (apps/Deployment) + frontend-web (core/Service) ``` Congratulations, you have deployed your first application using Radius! @@ -132,10 +164,12 @@ Congratulations, you have deployed your first application using Radius! ## Cleanup +Stop any remaining port forwards by pressing `Ctrl+C` (or close the terminal windows). + Delete the Todo List application: ```bash -rad app delete todolist +rad application delete todolist --preview ``` Optionally, uninstall Radius using the `purge` argument to remove Radius and all data: diff --git a/docs/content/reference/_index.md b/docs/content/reference/_index.md index 30d41b833..3a1d79588 100644 --- a/docs/content/reference/_index.md +++ b/docs/content/reference/_index.md @@ -1,7 +1,7 @@ --- type: docs -title: "Radius reference documentation" +title: "Reference" linkTitle: "Reference" -description: "Detailed reference documentation on various Radius components" -weight: 100 +description: "Technical reference for the Radius CLI, Resource Types, Recipes, and control plane" +weight: 900 --- diff --git a/docs/content/reference/api/_index.md b/docs/content/reference/api/_index.md index f1e396299..c07bd8b27 100644 --- a/docs/content/reference/api/_index.md +++ b/docs/content/reference/api/_index.md @@ -1,7 +1,7 @@ --- type: docs -title: "Radius API reference" -linkTitle: "Radius API" -description: "Detailed reference documentation on the Radius API" +title: "Radius control plane" +linkTitle: "Radius control plane" +description: "Detailed reference documentation on the Radius control plane" weight: 400 --- \ No newline at end of file diff --git a/docs/content/reference/api/api-ucp.md b/docs/content/reference/api/api-ucp.md index 8608c9a30..b28ac3c75 100644 --- a/docs/content/reference/api/api-ucp.md +++ b/docs/content/reference/api/api-ucp.md @@ -1,8 +1,9 @@ --- type: docs -title: "UCP API reference" -linkTitle: "UCP" -description: "Detailed reference documentation on the UCP API" +title: "Universal Control Plane API reference" +linkTitle: "Universal Control Plane API" +description: "Detailed reference documentation on the Universal Control Plane (UCP) API" +weight: 10 --- {{< redoc "swagger/specification/ucp/resource-manager/UCP/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.core/_index.md b/docs/content/reference/api/applications.core/_index.md deleted file mode 100644 index 63ff8fe3b..000000000 --- a/docs/content/reference/api/applications.core/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -type: docs -title: "Applications.Core API reference" -linkTitle: "Applications.Core" -description: "Detailed reference documentation on the Applications.Core API" ---- \ No newline at end of file diff --git a/docs/content/reference/api/applications.core/api-applications.md b/docs/content/reference/api/applications.core/api-applications.md deleted file mode 100644 index d86d9dd67..000000000 --- a/docs/content/reference/api/applications.core/api-applications.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Core/applications API reference" -linkTitle: "applications" -description: "Detailed reference documentation on the Applications.Core/applications API" -slug: "applications" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Core/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.core/api-containers.md b/docs/content/reference/api/applications.core/api-containers.md deleted file mode 100644 index 9809c7af5..000000000 --- a/docs/content/reference/api/applications.core/api-containers.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Core/containers API reference" -linkTitle: "containers" -description: "Detailed reference documentation on the Applications.Core/containers API" -slug: "containers" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Core/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.core/api-environments.md b/docs/content/reference/api/applications.core/api-environments.md deleted file mode 100644 index cdbf2cc76..000000000 --- a/docs/content/reference/api/applications.core/api-environments.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -type: api -title: "Applications.Core/environments API reference" -linkTitle: "environments" -description: "Detailed reference documentation on the Applications.Core/environments API" -slug: "environments" - ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Core/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.core/api-extenders.md b/docs/content/reference/api/applications.core/api-extenders.md deleted file mode 100644 index 93c501608..000000000 --- a/docs/content/reference/api/applications.core/api-extenders.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Core/extenders API reference" -linkTitle: "extenders" -description: "Detailed reference documentation on the Applications.Core/extenders API" -slug: "extenders" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Core/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.core/api-gateways.md b/docs/content/reference/api/applications.core/api-gateways.md deleted file mode 100644 index 81c4859fe..000000000 --- a/docs/content/reference/api/applications.core/api-gateways.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Core/gateways API reference" -linkTitle: "gateways" -description: "Detailed reference documentation on the Applications.Core/gateways API" -slug: "gateways" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Core/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.core/api-secretstores.md b/docs/content/reference/api/applications.core/api-secretstores.md deleted file mode 100644 index 7d3a29920..000000000 --- a/docs/content/reference/api/applications.core/api-secretstores.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Core/secretStores API reference" -linkTitle: "secretStores" -description: "Detailed reference documentation on the Applications.Core/secretStores API" -slug: "secret-stores" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Core/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.core/api-volumes.md b/docs/content/reference/api/applications.core/api-volumes.md deleted file mode 100644 index 5731acae2..000000000 --- a/docs/content/reference/api/applications.core/api-volumes.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Core/volumes API reference" -linkTitle: "volumes" -description: "Detailed reference documentation on the Applications.Core/volumes API" -slug: "volumes" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Core/preview/2023-10-01-preview/openapi.json" >}} diff --git a/docs/content/reference/api/applications.dapr/_index.md b/docs/content/reference/api/applications.dapr/_index.md deleted file mode 100644 index 71ec52145..000000000 --- a/docs/content/reference/api/applications.dapr/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -type: docs -title: "Applications.Dapr API reference" -linkTitle: "Applications.Dapr" -description: "Detailed reference documentation on the Applications.Dapr API" ---- \ No newline at end of file diff --git a/docs/content/reference/api/applications.dapr/api-configurationStores.md b/docs/content/reference/api/applications.dapr/api-configurationStores.md deleted file mode 100644 index dc7ba7314..000000000 --- a/docs/content/reference/api/applications.dapr/api-configurationStores.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Dapr/configurationStores API reference" -linkTitle: "configurationStores" -description: "Detailed reference documentation on the Applications.Dapr/configurationStores API" -slug: "configurationStores" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Dapr/preview/2023-10-01-preview/openapi.json" >}} \ No newline at end of file diff --git a/docs/content/reference/api/applications.dapr/api-pubsubbrokers.md b/docs/content/reference/api/applications.dapr/api-pubsubbrokers.md deleted file mode 100644 index 5a72e7d25..000000000 --- a/docs/content/reference/api/applications.dapr/api-pubsubbrokers.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Dapr/pubSubBrokers API reference" -linkTitle: "pubSubBrokers" -description: "Detailed reference documentation on the Applications.Dapr/pubSubBrokers API" -slug: "pubSubBrokers" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Dapr/preview/2023-10-01-preview/openapi.json" >}} \ No newline at end of file diff --git a/docs/content/reference/api/applications.dapr/api-secretStores.md b/docs/content/reference/api/applications.dapr/api-secretStores.md deleted file mode 100644 index 758d42825..000000000 --- a/docs/content/reference/api/applications.dapr/api-secretStores.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Dapr/secretStores API reference" -linkTitle: "secretStores" -description: "Detailed reference documentation on the Applications.Dapr/secretStores API" -slug: "secretStores" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Dapr/preview/2023-10-01-preview/openapi.json" >}} \ No newline at end of file diff --git a/docs/content/reference/api/applications.dapr/api-stateStores.md b/docs/content/reference/api/applications.dapr/api-stateStores.md deleted file mode 100644 index 1c2166e08..000000000 --- a/docs/content/reference/api/applications.dapr/api-stateStores.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Dapr/stateStores API reference" -linkTitle: "stateStores" -description: "Detailed reference documentation on the Applications.Dapr/stateStores API" -slug: "stateStores" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Dapr/preview/2023-10-01-preview/openapi.json" >}} \ No newline at end of file diff --git a/docs/content/reference/api/applications.datastores/_index.md b/docs/content/reference/api/applications.datastores/_index.md deleted file mode 100644 index 3d85d35be..000000000 --- a/docs/content/reference/api/applications.datastores/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Applications.Datastores API reference" -linkTitle: "Applications.Datastores" -description: "Detailed reference documentation on the Applications.Datastores API" ---- - diff --git a/docs/content/reference/api/applications.datastores/api-mongodatabases.md b/docs/content/reference/api/applications.datastores/api-mongodatabases.md deleted file mode 100644 index 022eb2eef..000000000 --- a/docs/content/reference/api/applications.datastores/api-mongodatabases.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Datastores/mongoDatabases API reference" -linkTitle: "mongoDatabases" -description: "Detailed reference documentation on the Applications.Datastores/mongoDatabases API" -slug: "mongoDatabases" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Datastores/preview/2023-10-01-preview/openapi.json" >}} \ No newline at end of file diff --git a/docs/content/reference/api/applications.datastores/api-rediscaches.md b/docs/content/reference/api/applications.datastores/api-rediscaches.md deleted file mode 100644 index 461887bdb..000000000 --- a/docs/content/reference/api/applications.datastores/api-rediscaches.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Datastores/redisCaches API reference" -linkTitle: "redisCaches" -description: "Detailed reference documentation on the Applications.Datastores/redisCaches API" -slug: "redisCaches" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Datastores/preview/2023-10-01-preview/openapi.json" >}} \ No newline at end of file diff --git a/docs/content/reference/api/applications.datastores/api-sqldatabases.md b/docs/content/reference/api/applications.datastores/api-sqldatabases.md deleted file mode 100644 index 9c727c2f0..000000000 --- a/docs/content/reference/api/applications.datastores/api-sqldatabases.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Datastores/sqlDatabases API reference" -linkTitle: "sqlDatabases" -description: "Detailed reference documentation on the Applications.Datastores/sqlDatabases API" -slug: "sqlDatabases" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Datastores/preview/2023-10-01-preview/openapi.json" >}} \ No newline at end of file diff --git a/docs/content/reference/api/applications.messaging/_index.md b/docs/content/reference/api/applications.messaging/_index.md deleted file mode 100644 index 2a8955814..000000000 --- a/docs/content/reference/api/applications.messaging/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -type: docs -title: "Applications.Messaging API reference" -linkTitle: "Applications.Messaging" -description: "Detailed reference documentation on the Applications.Messaging API" ---- diff --git a/docs/content/reference/api/applications.messaging/api-rabbitmqqueues.md b/docs/content/reference/api/applications.messaging/api-rabbitmqqueues.md deleted file mode 100644 index 1a845c129..000000000 --- a/docs/content/reference/api/applications.messaging/api-rabbitmqqueues.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -type: api -title: "Applications.Messaging/rabbitmqQueues API reference" -linkTitle: "rabbitmqQueues" -description: "Detailed reference documentation on the Applications.Messaging/rabbitmqQueues API" -slug: "rabbitmqQueues" ---- - -{{< redoc "swagger/specification/applications/resource-manager/Applications.Messaging/preview/2023-10-01-preview/openapi.json" >}} \ No newline at end of file diff --git a/docs/content/reference/metrics.md b/docs/content/reference/api/metrics.md similarity index 83% rename from docs/content/reference/metrics.md rename to docs/content/reference/api/metrics.md index db61be6f1..91940cc7a 100644 --- a/docs/content/reference/metrics.md +++ b/docs/content/reference/api/metrics.md @@ -1,13 +1,13 @@ --- type: docs -title: "Reference: Available Radius metrics" +title: "Radius control plane metrics" linkTitle: "Metrics" -weight: 850 -description: "Learn what metrics are available for the Radius control plane" +weight: 40 +description: "Learn what metrics are available for monitoring the Radius control plane" categories: ["Reference"] --- -Radius currently records following custom metrics that provide insight into its health and operations: +Radius currently records the following custom metrics that provide insight into its health and operations: - [Async operation metrics](#async-operation-metrics) - [Recipe Engine metrics](#recipe-engine-metrics) diff --git a/docs/content/reference/api/resource-ids/index.md b/docs/content/reference/api/resource-ids/index.md index 2e3230416..20d7c2c29 100644 --- a/docs/content/reference/api/resource-ids/index.md +++ b/docs/content/reference/api/resource-ids/index.md @@ -3,11 +3,10 @@ type: docs title: Radius Resource IDs linkTitle: Resource IDs description: Learn about the structure of Resource IDs +weight: 100 --- -## Overview - -Each resource in Radius has a unique identifier called a resource ID. Resource IDs have a common structure that allows resources to reference one-another. Resource IDs also map directly to the URLs used for a resource's lifecycle operations which is convenient for navigating the API. +Each resource in Radius has a unique identifier called a resource ID. Resource IDs have a common structure that allows resources to reference one another. Resource IDs also map directly to the URLs used for a resource's lifecycle operations, which is convenient for navigating the API. The common structure of a resource ID is: @@ -15,29 +14,32 @@ The common structure of a resource ID is: {rootScope}/providers/{resourceNamespace}/{resourceType}/{resourceName} ``` -### Root scope +## Root scope A hierarchical set of key-value pairs that identify the origin of the resource. Root scopes answer questions like: - *"What cloud is this resource from?"* - *"What cloud account contains this resource?"* -- *"What Kubernetes cluster is running this Pod?"*. +- *"What Kubernetes cluster is running this Pod?"* + +For example, a resource in the `my-group` resource group on the local Radius plane has the root scope `/planes/radius/local/resourceGroups/my-group`. + +## Resource namespace and resource type -### Resource namespace and resource type +A resource's type is written as two segments joined by a slash: a *namespace* and a *type name*. For example, in `Radius.Core/applications` the namespace is `Radius.Core` and the type name is `applications`. -The namespace and type of a resource. These are defined together because resource types are usually two segments - a vendor namespace and a type name. +The namespace groups related resource types under a common vendor or domain. For example, `Radius.Core` contains the core Radius types such as `applications` and `environments`, while `Radius.Data` contains data resource types such as `postgreSqlDatabases`. The type name identifies a specific kind of resource within that namespace. -### Resource name +Because the namespace and type name together identify a resource type, they always appear as a pair (`{resourceNamespace}/{resourceType}`) in a resource ID, immediately after the `providers` segment. -The name of the resource. +## Resource name -### Examples +The final segment of a resource ID, identifying a specific resource instance within its type. A resource name is unique within a given root scope and resource type, so the same name can be reused across different types or resource groups. For example, an application named `my-app` has the resource name `my-app`. -This example shows a Radius Application named `my-app` in the `my-group` resource group, running on the local cluster: +## Example -| Key | Example | -| ------------------ | ---------------------------------------------------------------------------------------------- | -| **Root scope** | `/planes/radius/local/resourceGroups/my-group` | -| **Namespace/Type** | `Applications.Core/applications` | -| **Name** | `my-app` | -| **Resource ID** | `/planes/radius/local/resourceGroups/my-group/providers/Applications.Core/applications/my-app` | +Combining a root scope, a namespace and type, and a name produces a complete resource ID. For example, a Radius application named `my-app` in the `my-group` resource group on the local cluster has the following resource ID: + +```txt +/planes/radius/local/resourceGroups/my-group/providers/Radius.Core/applications/my-app +``` diff --git a/docs/content/reference/api/resource-policies/index.md b/docs/content/reference/api/resource-policies/index.md deleted file mode 100644 index c44bbb206..000000000 --- a/docs/content/reference/api/resource-policies/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -type: docs -title: "API timeout/retry policies" -linkTitle: "Timeout/retry policies" -description: "Learn the timeout/retry policies of the Radius API" ---- - -## Radius services - -There are two main Radius services that will provide the resources described below: - -- Deployment Engine -- Resource Provider - -See [Concepts]({{< ref "concepts" >}}) for background on these components. - -## Deployment engine behavior - -| Operation | Resource Name | Server Timeout (Seconds) | Async Operation retry condition| -|------|:--------:|-------------|---------|------------| -| Default retry timeout for resource deployment | The name of your resource. | 12.5 minutes per resource | Retries on 5xx errors, 50 retry requests -| Default request timeout | | Dependent on UCP | - -### Resource provider behavior - -#### Timeout duration - -The default timeout times are listed below but be aware that the asynchronous timeout varies per resource type. - -- Default synchronous API timeout : 60 seconds. It depends on UCP gateway timeout. -- Default asynchronous API timeout : 120 seconds - -#### Asynchronous operation retry policy - -Each resource type controller decides whether it will retry to process the operation when it fails, but the current async operation controller immediately marks any errors as a `Failed` operation except for the following scenario: - -- Panic happens while processing the async operation by code defect (retry once, then mark the operation Failed) -- Resource provider process exits by unexpected process crashes (such as node failure, memory leak) and redeploying Radius. (retry once , then mark the operation Failed) - -#### Applications.Core resource provider - -| Resource Type | Operation | API Type | Server Timeout (Seconds) | Async Operation retry condition| -|------|:--------:|-------------|---------|------------| -| Applications.Core/environments | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Core/applications | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Core/containers | LIST/GET | Synchronous | default | | -| Applications.Core/containers | PUT/PATCH/DELETE | Asynchronous | 300 | default | -| Applications.Core/gateways | LIST/GET | Synchronous | default | | -| Applications.Core/gateways | PUT/PATCH/DELETE | Asynchronous | default | default | -| Applications.Core/extenders | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Core/extenders | POST ListSecret | Synchronous | default | | - -#### Applications.Dapr resource providers - -| Resource Type | Operation | API Type | Server Timeout (Seconds) | Async Operation retry condition| -|------|:--------:|-------------|---------|------------| -| Applications.Dapr/pubSubBrokers | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Dapr/pubSubBrokers | POST ListSecret | Synchronous | default | | -| Applications.Dapr/secretStores | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Dapr/secretStores | POST ListSecret | Synchronous | default | | -| Applications.Dapr/stateStores | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Dapr/stateStores | POST ListSecret | Synchronous | default | | - -#### Applications.Datastores resource providers - -| Resource Type | Operation | API Type | Server Timeout (Seconds) | Async Operation retry condition| -|------|:--------:|-------------|---------|------------| -| Applications.Datastores/mongoDatabases | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Datastores/mongoDatabases | POST ListSecret | Synchronous | default | | -| Applications.Datastores/rabbitMQMessageQueues | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Datastores/rabbitMQMessageQueues | POST ListSecret | Synchronous | default | | -| Applications.Datastores/redisCaches | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Datastores/redisCaches | POST ListSecret | Synchronous | default | | -| Applications.Datastores/sqlDatabases | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | -| Applications.Datastores/sqlDatabases | POST ListSecret | Synchronous | default | | diff --git a/docs/content/reference/cli/_index.md b/docs/content/reference/cli/_index.md index 342cc9be7..94cf0b792 100644 --- a/docs/content/reference/cli/_index.md +++ b/docs/content/reference/cli/_index.md @@ -1,7 +1,42 @@ --- type: docs title: "Radius CLI reference" -linkTitle: "rad CLI" -description: "Detailed reference documentation on the Radius CLI" +linkTitle: "Radius CLI" +description: "Reference documentation for the Radius CLI" weight: 100 ---- \ No newline at end of file +aliases: + - /reference/cli/config/ +--- + +## Introduction + +The Radius CLI (`rad`) is the primary tool for interacting with Radius from your terminal. This section contains reference material for each `rad` command as well as the [local workspace configuration file](#local-workspace-config), which stores the settings that connect the CLI to your Radius control plane. + +All of the command reference material here is also available directly from your terminal by running `rad --help`. + +## Local workspace config + +Radius stores [Workspaces]({{< ref "/management/workspaces" >}}) in a local `config.yaml` file that selects the control plane, Resource Group, and Environment that `rad` commands target: + +- **macOS/Linux:** `~/.rad/config.yaml` +- **Windows:** `%USERPROFILE%\.rad\config.yaml` + +```yaml +workspaces: + default: dev # Workspace used when --workspace is omitted + items: + dev: + connection: + kind: kubernetes + context: DevCluster # Kubernetes context used to reach the control plane + environment: /planes/radius/local/resourceGroups/dev/providers/Radius.Core/environments/dev + scope: /planes/radius/local/resourceGroups/dev # Default Resource Group +``` + +| Key | Description | +|-----|-------------| +| `default` | Name of the Workspace used when `--workspace` is not passed. | +| `items..connection.kind` | Connection type. Use `kubernetes` for a Kubernetes-hosted control plane. | +| `items..connection.context` | Kubernetes context used to reach the control plane. | +| `items..environment` | Default Environment resource ID for the Workspace. | +| `items..scope` | Default Resource Group scope for `rad` commands. | diff --git a/docs/content/reference/config.md b/docs/content/reference/config.md deleted file mode 100644 index c14ea4677..000000000 --- a/docs/content/reference/config.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -type: docs -title: "Radius Configuration file" -linkTitle: "config.yaml" -description: "Detailed reference documentation on the Radius config.yaml configuration file" -weight: 500 ---- - -Radius [workspaces]({{< ref workspaces >}}) are used to easily switch between environments. - -```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 -``` - -## Default location - -- **macOS/Linux:** `~/.rad/config.yaml` -- **Windows:** `%USERPROFILE%\.rad\config.yaml` - -## Schema - -### workspaces - -| Key | Description | Example | -|-----|-------------|---------| -| **default** | The name of the default workspace to use with rad CLI commands | `dev` | -| [**items**](#items) | A list of workspaces | - -#### items - -| Key | Description | Example | -|-----|-------------|---------| -| **[workspace-name]** | The name of the workspace. Used as the key for the list entry. | `dev` | -| [**connection**](#connection) | The connection details for the target Radius platform | | -| **environment** | The default environment UCP ID to use for the workspace. Can be empty if no environment exists or if no default set | `/planes/radius/local/resourcegroups/dev/providers/applications.core/environments/dev` | -| **scope** | The default scope UCP ID to use for the workspace | `/planes/radius/local/resourcegroups/dev` | - -#### connection - -| Key | Description | Example | -|-----|-------------|---------| -| **context** | The name of the Kubernetes context to use | `DevCluster` | -| **namespace** | The name of the Kubernetes namespace to use when deploying Radius Applications | `default` | - diff --git a/docs/content/reference/context-schema/index.md b/docs/content/reference/context-schema/index.md deleted file mode 100644 index 68845e8d1..000000000 --- a/docs/content/reference/context-schema/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -type: docs -title: "Reference: Recipe context object schema" -linkTitle: "Recipe context" -description: "Learn how to use the Recipe context object in your Recipe templates" -categories: "Reference" -weight: 800 ---- - -The `context` object is automatically injected to Bicep templates when a Recipe is run. It contains information about the runtime, environment, application, and resource from which the Recipe was run. This enables you to author templates that can be used as Recipes. For more information visit the [Recipe authoring how-to guide]({{< ref howto-author-recipes >}}). - -## Usage - -{{< tabs Bicep >}} - -{{< codetab >}} - -{{< rad file="snippets/recipe.bicep" embed=true >}} - -{{< /codetab >}} - -{{< /tabs >}} - -| Key | Type | Description | -|-----|------|-------------| -| [`resource`](#resource) | object | Represents the resource metadata of the deploying recipe resource. -| [`application`](#application) | object | Represents application metadata. -| [`environment`](#environment) | object | Represents environment metadata. -| [`runtime`](#runtime) | object | An object containing information on the underlying runtime. -| [`azure`](#azure) | object | Represents Azure provider scope metadata. -| [`aws`](#aws) | object | Represents AWS provider scope metadata. - -### resource - -| Key | Type | Description | Example | -|-----|------|-------------|---------| -| `name` | string | The name of the resource calling this Recipe | `myredis` -| `id` | string | The ID of the resource calling this Recipe | `/planes/radius/resourceGroups/myrg/Applications.Link/redisCaches/myredis` -| `type` | string | The type of the resource calling this recipe | `Applications.Link/redisCaches` -| `properties` | object | The properties of the resource calling this recipe | `{ "cpuCores": 4, "memory": "8GB" }` - -### application - -| Key | Type | Description | Example | -|-----|------|-------------|---------| -| `name` | string | The name of the application | `myapp` -| `id` | string | The resource ID of the application | `/planes/radius/resourceGroups/myrg/Applications.Core/applications/myapp` - -### environment - -| Key | Type | Description | Example | -|-----|------|-------------|---------| -| `name` | string | The name of the environment | `myenv` -| `id` | string | The resource ID of the environment | `/planes/radius/resourceGroups/myrg/Applications.Core/environments/myenv` - -### runtime - -| Key | Type | Description | -|-----|------|-------------| -| [`kubernetes`](#kubernetes) | object | An object with details of the underlying Kubernetes cluster, if configured on the environment - -#### kubernetes - -| Key | Type | Description | -|-----|------|-------------| -| `namespace` | string | Set to the application's namespace when the resource is application-scoped, and set to the environment's namespace when the resource is environment scoped. -| `environmentNamespace` | string | Set to the environment's namespace. - -### azure - -| Key | Type | Description | -|-----|------|-------------| -| [`resourceGroup`](#resourceGroup) | object | An object with details of the Azure Resource Group provider information, if configured on the environment -| [`subscription`](#subscription) | object | An object with details of the Azure Subscription provider information, if configured on the environment - -#### resourceGroup - -| Key | Type | Description | -|-----|------|-------------| -| `name` | string | The resource group name. -| `id` | string | Represents fully qualified resource group id. - -#### subscription - -| Key | Type | Description | -|-----|------|-------------| -| `subscriptionId` | string | The GUID of the subscription. -| `id` | string | Represents fully qualified subscription id. - -### aws - -| Key | Type | Description | -|-----|------|-------------| -| `region` | string | Represents the region where AWS resources are deployed. -| `account` | string | Represents the account id of the AWS account. diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md deleted file mode 100644 index ac24eb403..000000000 --- a/docs/content/reference/limitations.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -type: docs -title: "Known issues and limitations with the latest Radius release" -linkTitle: "Limitations" -description: "Learn where there are known issues and limitations with the latest Radius release and how to work around them" -weight: 998 ---- - -## Radius control plane - -### `rad install kubernetes` and `rad init` installs Contour in addition to Radius - -Contour is also installed into the `radius-system` namespace to help get you up and running quickly. This is a point-in-time limitation that will be addressed with richer environment customization in a future update. - -## Radius resources - -### Resource names must be unique for a given resource type across applications - -Resources for a given type must currently have unique names within a [workspace]({{< ref workspaces >}}). For example, if two applications both have a `frontend` container resource, the first application deployment into any environment associated with the workspace will succeed while the second will fail. - -As a workaround, use separate workspaces for applications that have repeated resource names for a given type. - -This will be addressed further in a future release. - -### Changing the Kubernetes namespace of an environment or application requires the app to be deleted and redeployed - -A Radius Environment allows you to specify Kubernetes as your compute platform, as well as specify the Kubernetes namespace in which Kubernetes objects are deployed. Additionally, you can override the namespace for a specific application using the [kubernetesNamespace extension.]({{< ref "application-schema#kubernetesNamespace" >}}). Currently, changing the namespace of an environment or application requires the application to be deleted and redeployed. If you need to change the namespace of an application, you can do so by deleting the application and/or environment and redeploying it with the new namespace. - -### Resource names cannot contain underscores (\_) - -Using an underscore in a resource name will result in an error. - -As a workaround do not use underscores in resource names. Additional validation will be added in a future release to help warn against improperly formatted resource names. - -See [app name constraints]({{< ref "resource-schema.md#common-values" >}}) for more information. - -### Gateway resources and container resources cannot share names - -Deploying a Radius Application that contains a gateway resource and a container resource that share a name will result in an error being thrown during deployment. For example, when attempting to name a container and a gateway something like "foo", you'll get an error messaging similar to: - -``` -Error - Type: IncludeError, Status: True, Reason: RootIncludesRoot, Message: root httpproxy cannot include another root httpproxy -``` - -As a workaround make sure to use distinct names for both containers and gateways. - -### Typos in Radius Resource Type Names - -Deploying a Radius Resources with a typo in the resource type or an unsupported resource type will result in an Azure provider related error being thrown during deployment. For example, when `Application.Core/Extenders` is defined as `Application.Core/Extender` you will get an error messaging similar to: - -``` -Azure deployment failed, please ensure you have configured an Azure provider with your Radius environment: https://docs.radapp.io/guides/operations/providers/azure-provider/ -``` - -We are working on making this error clearer. In the meantime, when you see this error please ensure that the resource type name is correctly specified in your Radius Application or Environment Bicep file. - -## rad CLI - -### Application and resource names are lower-cased after deployment - -After deploying an application with application name `AppNAME` and container name `CONTAINERname`, casing information about the casing is lost, resulting in names to be lower-cased. The result is: - -```bash -rad application list -RESOURCE TYPE -appname applications.core/applications - -rad resource list containers -a appname -RESOURCE TYPE -containername applications.core/containers -``` - -### Environment creation and last modified times are incorrect - -When running `rad env show`, the `lastmodifiedat` and `createdat` fields display `0001-01-01T00:00:00Z` instead of the actual times. - -This will be addressed in an upcoming release. - -## Recipes - -### Kubernetes Bicep resources require manual UCP ID output - -The Bicep deployment engine currently does not output Kubernetes resource (UCP) IDs upon completion, meaning Recipes cannot automatically link a Recipe-enabled resource to the underlying infrastructure. This also means Kubernetes resources are not automatically cleaned up when a Recipe-enabled resource is deleted. - -To fix this, you can manually build and output UCP IDs, which will cause the infrastructure to be linked to the resource: - -```bicep -extension kubernetes with { - kubeConfig: '' - namespace: 'default' -} as k8s - -resource deployment 'apps/Deployment@v1' = {...} - -resource service 'core/Service@v1' = {...} - -output values object = { - resources: [ - // Manually build UCP IDs (/planes//local/namespaces//providers///) - '/planes/kubernetes/local/namespaces/${deployment.metadata.namespace}/providers/apps/Deployment/${deployment.metadata.name}' - '/planes/kubernetes/local/namespaces/${service.metadata.namespace}/providers/core/Service/${service.metadata.name}' - ] -} -``` - -## Bicep & Deployment Engine - -### `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. - -To access `environment()`, prefix it with `az.`. For example: - -```bicep -extension radius - -param environment string - -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. - -### 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 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. - -As a workaround, you can try using [Terraform Recipes]({{< ref "concepts/recipes" >}}) to deploy and manage those non-idempotent resource types. - -## GitHub - -### Visual Studio not authorized for single sign-on - -If you receive an error saying Visual Studio Code or another application is not authorized to clone any of the Radius repositories you may need to re-authorize the GitHub app: - -1. Open a browser to -1. Find the applicable app and select Revoke -1. Reopen app on local machine and re-auth diff --git a/docs/content/reference/recipes/_index.md b/docs/content/reference/recipes/_index.md new file mode 100644 index 000000000..38b13f8e1 --- /dev/null +++ b/docs/content/reference/recipes/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Recipes reference" +linkTitle: "Recipes reference" +description: "Reference documentation for Radius recipes" +weight: 300 +--- diff --git a/docs/content/reference/recipes/context/index.md b/docs/content/reference/recipes/context/index.md new file mode 100644 index 000000000..67a9345a2 --- /dev/null +++ b/docs/content/reference/recipes/context/index.md @@ -0,0 +1,111 @@ +--- +type: docs +title: "Recipe context object" +linkTitle: "Recipe context" +description: "Learn how to use the context object in your recipes" +weight: 100 +--- + +Radius automatically injects the `context` object into each recipe at deploy time. It carries metadata about the resource being deployed and the application, environment, and runtime it belongs to, along with the Azure and AWS provider scopes configured on the Environment. The context is a normalized recipe contract, not a copy of the Environment resource schema. For example, Radius maps `Radius.Core/environments.properties.providers.kubernetes.namespace` to `context.runtime.kubernetes.namespace`. You declare `context` as a parameter in a Bicep recipe (`param context object`) or as an input variable in a Terraform recipe (`variable "context"`), then reference its values to generate names, resolve namespaces, and configure the infrastructure your recipe deploys. For more information, visit the [recipe authoring how-to guide]({{< ref "/extensibility/recipes" >}}). + +## Usage + +{{< tabs Terraform Bicep >}} + +{{< codetab >}} + +{{< rad file="snippets/recipe.tf" embed=true lang="terraform" >}} + +{{< /codetab >}} + +{{< codetab >}} + +{{< rad file="snippets/recipe.bicep" embed=true >}} + +{{< /codetab >}} + +{{< /tabs >}} + +## Properties + +| Key | Type | Description | +|-----|------|-------------| +| [`resource`](#resource) | object | Metadata about the resource, defined in the application definition, being deployed including its name, ID, type, and properties. | +| [`application`](#application) | object | Metadata about the application the resource belongs to. Populated only when the resource is application-scoped. | +| [`environment`](#environment) | object | Metadata about the environment the resource is deployed into. | +| [`runtime`](#runtime) | object | Details about the target runtime that hosts the deployed resources, such as the Kubernetes cluster. | +| [`azure`](#azure) | object | The Azure provider scope (subscription and resource group) for the deployment. Present only when an Azure provider is configured on the environment. | +| [`aws`](#aws) | object | The AWS provider scope (account and region) for the deployment. Present only when an AWS provider is configured on the environment. | + +### resource + +| Key | Type | Description | Example | +|-----|------|-------------|---------| +| `name` | string | The name of the resource being deployed | `postgresql` | +| `id` | string | The ID of the resource being deployed | `/planes/radius/local/resourceGroups/default/providers/Radius.Data/postgreSqlDatabases/postgresql` | +| `type` | string | The type of the resource being deployed | `Radius.Data/postgreSqlDatabases` | +| `properties` | object | The properties of the resource being deployed | `{ "size": "S", "database": "appdb" }` | +| [`connections`](#connections) | object | A map of the resource's connections to other resources, keyed by connection name. Each entry exposes the connected resource's metadata and properties. | | + +#### connections + +| Key | Type | Description | Example | +|-----|------|-------------|---------| +| `name` | string | The name of the connected resource. | `database` | +| `id` | string | The ID of the connected resource. | `/planes/radius/local/resourceGroups/default/providers/Radius.Data/postgreSqlDatabases/database` | +| `type` | string | The type of the connected resource. | `Radius.Data/postgreSqlDatabases` | +| `properties` | object | The properties of the connected resource. | `{ "host": "localhost", "port": 5432 }` | + +### application + +| Key | Type | Description | Example | +|-----|------|-------------|---------| +| `name` | string | The name of the application | `todolist` | +| `id` | string | The resource ID of the application | `/planes/radius/local/resourceGroups/default/providers/Radius.Core/applications/todolist` | + +### environment + +| Key | Type | Description | Example | +|-----|------|-------------|---------| +| `name` | string | The name of the environment | `default` | +| `id` | string | The resource ID of the environment | `/planes/radius/local/resourceGroups/default/providers/Radius.Core/environments/default` | + +### runtime + +| Key | Type | Description | +|-----|------|-------------| +| [`kubernetes`](#kubernetes) | object | An object with details of the underlying Kubernetes cluster, if configured on the environment | + +#### kubernetes + +| Key | Type | Description | Example | +|-----|------|-------------|---------| +| `namespace` | string | The Kubernetes namespace the recipe should deploy its resources into. Set from the environment's `providers.kubernetes.namespace`. | `default` | + +### azure + +| Key | Type | Description | +|-----|------|-------------| +| [`resourceGroup`](#resourceGroup) | object | An object with details of the Azure resource group, if configured on the environment | +| [`subscription`](#subscription) | object | An object with details of the Azure subscription, if configured on the environment | + +#### resourceGroup + +| Key | Type | Description | Example | +|-----|------|-------------|---------| +| `name` | string | The resource group name where resources are deployed. | `myrg` | +| `id` | string | The fully qualified Azure resource group ID. | `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg` | + +#### subscription + +| Key | Type | Description | Example | +|-----|------|-------------|---------| +| `subscriptionId` | string | The GUID of the subscription where resources are deployed. | `00000000-0000-0000-0000-000000000000` | +| `id` | string | The fully qualified Azure subscription ID. | `/subscriptions/00000000-0000-0000-0000-000000000000` | + +### aws + +| Key | Type | Description | Example | +|-----|------|-------------|---------| +| `region` | string | The AWS region where resources are deployed. | `us-west-2` | +| `account` | string | The AWS account ID. | `123456789012` | diff --git a/docs/content/reference/context-schema/snippets/recipe.bicep b/docs/content/reference/recipes/context/snippets/recipe.bicep similarity index 100% rename from docs/content/reference/context-schema/snippets/recipe.bicep rename to docs/content/reference/recipes/context/snippets/recipe.bicep diff --git a/docs/content/reference/recipes/context/snippets/recipe.tf b/docs/content/reference/recipes/context/snippets/recipe.tf new file mode 100644 index 000000000..da96bbd82 --- /dev/null +++ b/docs/content/reference/recipes/context/snippets/recipe.tf @@ -0,0 +1,9 @@ +variable "context" { + description = "Radius-provided object containing information about the resource calling the recipe" + type = any +} + +locals { + resource_name = var.context.resource.name + namespace = var.context.runtime.kubernetes.namespace +} diff --git a/docs/content/reference/recipes/result/index.md b/docs/content/reference/recipes/result/index.md new file mode 100644 index 000000000..0824d136f --- /dev/null +++ b/docs/content/reference/recipes/result/index.md @@ -0,0 +1,87 @@ +--- +type: docs +title: "Recipe result object" +linkTitle: "Recipe result" +description: "Learn how to use the result object to return values from a recipe" +weight: 200 +--- + +A recipe returns data to Radius through a special output named `result`. After a recipe provisions its infrastructure, the `result` object carries the values, secrets, and resource IDs that Radius records on the resource that called the recipe. Radius surfaces those values to the resource and to any resources that connect to it, stores secrets securely, and tracks the returned resource IDs so it can manage their lifecycle. A recipe returns it from an `output result object` in Bicep or an `output "result"` in Terraform. For more information, visit the [recipe authoring how-to guide]({{< ref "/extensibility/recipes" >}}). + +## Usage + +{{< tabs Terraform Bicep >}} + +{{< codetab >}} + +{{< rad file="snippets/recipe.tf" embed=true lang="terraform" >}} + +{{% alert title="πŸ’‘ Terraform recipes" color="info" %}} +The Terraform `result` output must be marked `sensitive = true`. Because non-sensitive values and secrets are combined into a single object, Terraform requires the whole output to be marked sensitive. +{{% /alert %}} + +{{< /codetab >}} + +{{< codetab >}} + +{{< rad file="snippets/recipe.bicep" embed=true >}} + +{{< /codetab >}} + +{{< /tabs >}} + +## Properties + +| Key | Type | Description | +|-----|------|-------------| +| [`values`](#values) | object | A map of non-sensitive key/value pairs to record on the resource. These become the resource's computed properties and are surfaced to connecting resources. | +| [`secrets`](#secrets) | object | A map of sensitive key/value pairs. Radius stores these securely and surfaces them to connecting resources without exposing them as plain values. | +| [`resources`](#resources) | array | A list of resource IDs that Radius should associate with the resource so it can manage their lifecycle. | + +### values + +`values` is a map of non-sensitive key/value pairs. Radius records each entry as a computed property on the resource that called the recipe and makes it available to any resource that connects to itβ€”for example, a container reads them through connection environment variables. + +| Type | Example | +|------|---------| +| object | `{ "host": "db.default.svc.cluster.local", "port": 5432, "database": "appdb" }` | + +### secrets + +`secrets` is a map of sensitive key/value pairs, such as passwords or connection strings. Radius stores these values securely and surfaces them to connecting resources without exposing them as plain values. + +| Type | Example | +|------|---------| +| object | `{ "username": "postgres", "password": "***" }` | + +### resources + +`resources` is an array of fully qualified resource IDs. Radius associates each ID with the resource that called the recipe so it can manage the returned resources' lifecycleβ€”for example, deleting them when the resource is deleted. + +| Type | Example | +|------|---------| +| array | `["/planes/kubernetes/local/namespaces/default/providers/core/Service/redis"]` | + +## How Radius uses the result + +When a recipe finishes, Radius reads the `result` output and: + +- Records the `values` as computed properties on the resource and passes them to any resource that connects to it (for example, as `CONNECTION__` environment variables on a container). +- Stores the `secrets` securely and surfaces them to connecting resources without exposing them as plain values. +- Adds the resource IDs in `resources` to the resource's list of tracked output resources so they are managedβ€”and cleaned upβ€”alongside the resource. + +Radius also records status metadata about the recipe (such as the template kind and path) on the resource automatically. This metadata is not set in the `result` object. + +{{% alert title="⚠️ Unknown fields" color="warning" %}} +Radius rejects a `result` object that contains keys other than `values`, `secrets`, and `resources`. A recipe must return only these three properties. +{{% /alert %}} + +## When is the result required? + +Returning a `result` object is optional, but it is required in the following cases: + +- **To populate the resource's properties.** When the resource type defines read-only properties that the recipe computes (such as `host`, `port`, or a connection string), those values must be returned under `values` so they appear on the resource and flow to connecting resources. +- **To return secrets.** Any sensitive value the consuming application needsβ€”such as a password or connection stringβ€”must be returned under `secrets`. +- **To track resources Radius can't discover implicitly.** Radius automatically tracks ARM and UCP resources that a Bicep recipe creates. Other resourcesβ€”most commonly Kubernetes resourcesβ€”are not returned automatically, so their IDs must be listed under `resources` for Radius to manage their lifecycle. + +When a recipe doesn't compute any properties or secrets and only creates resources that Radius tracks implicitly, the `result` output can be omitted entirely. \ No newline at end of file diff --git a/docs/content/reference/recipes/result/snippets/recipe.bicep b/docs/content/reference/recipes/result/snippets/recipe.bicep new file mode 100644 index 000000000..b639befef --- /dev/null +++ b/docs/content/reference/recipes/result/snippets/recipe.bicep @@ -0,0 +1,30 @@ +@description('Radius-provided object containing information about the resource calling the recipe') +param context object + +// ... deploy your infrastructure here ... + +// Example values produced by the infrastructure the recipe deploys. +var service = { + metadata: { + name: 'redis' + namespace: context.runtime.kubernetes.namespace + } +} +var password = 'example-password' + +output result object = { + // Resource IDs that Radius should track as part of this resource's lifecycle. + resources: [ + '/planes/kubernetes/local/namespaces/${service.metadata.namespace}/providers/core/Service/${service.metadata.name}' + ] + // Non-sensitive values surfaced to the resource and its connections. + values: { + host: '${service.metadata.name}.${service.metadata.namespace}.svc.cluster.local' + port: 6379 + } + // Sensitive values stored securely as secrets. + secrets: { + #disable-next-line outputs-should-not-contain-secrets + password: password + } +} diff --git a/docs/content/reference/recipes/result/snippets/recipe.tf b/docs/content/reference/recipes/result/snippets/recipe.tf new file mode 100644 index 000000000..3917cd8e5 --- /dev/null +++ b/docs/content/reference/recipes/result/snippets/recipe.tf @@ -0,0 +1,30 @@ +variable "context" { + description = "Radius-provided object containing information about the resource calling the recipe" + type = any +} + +locals { + namespace = var.context.runtime.kubernetes.namespace +} + +# ... deploy your infrastructure here ... + +output "result" { + # Mark the output sensitive because values and secrets are combined into one object. + sensitive = true + value = { + # Resource IDs that Radius should track as part of this resource's lifecycle. + resources = [ + "/planes/kubernetes/local/namespaces/${local.namespace}/providers/core/Service/${kubernetes_service.redis.metadata[0].name}" + ] + # Non-sensitive values surfaced to the resource and its connections. + values = { + host = "${kubernetes_service.redis.metadata[0].name}.${local.namespace}.svc.cluster.local" + port = 6379 + } + # Sensitive values stored securely as secrets. + secrets = { + password = random_password.password.result + } + } +} diff --git a/docs/content/reference/resource-schema/_index.md b/docs/content/reference/resource-schema/_index.md deleted file mode 100644 index 1ae5f2338..000000000 --- a/docs/content/reference/resource-schema/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Resource schemas" -linkTitle: "Resource schemas" -description: "Schema docs for the resources that can comprise a Radius Application" -weight: 300 ---- diff --git a/docs/content/reference/resource-schema/aws/index.md b/docs/content/reference/resource-schema/aws/index.md deleted file mode 100644 index 49b8cb51a..000000000 --- a/docs/content/reference/resource-schema/aws/index.md +++ /dev/null @@ -1,1228 +0,0 @@ ---- -type: docs -title: "Supported AWS resources" -linkTitle: "Supported AWS resources " -description: "Learn about the supported AWS resource types in Radius" -categories: "Schema" ---- - -Radius supports AWS resource types that are supported by the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html). - -Following table lists the resource types that are currently supported and the limitations for each of the resource types. - -| Resource Type | Notes | -| ------------- | ----- | -| **[AWS::ACMPCA::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.acmpca/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ACMPCA::CertificateAuthority](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.acmpca/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ACMPCA::CertificateAuthorityActivation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.acmpca/default/types.md)** | | -| **[AWS::APS::RuleGroupsNamespace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.aps/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::APS::Workspace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.aps/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AccessAnalyzer::Analyzer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.accessanalyzer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Amplify::App](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplify/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Amplify::Branch](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplify/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Amplify::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplify/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AmplifyUIBuilder::Component](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AmplifyUIBuilder::Form](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AmplifyUIBuilder::Theme](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Account](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::ApiKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Authorizer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::BasePathMapping](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::ClientCertificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Deployment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::DocumentationPart](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::DocumentationVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::DomainName](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::Method](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::Model](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::RequestValidator](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Resource](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::RestApi](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Stage](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::UsagePlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::VpcLink](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Api](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Authorizer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Deployment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Model](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Route](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::VpcLink](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppConfig::Extension](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appconfig/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppConfig::ExtensionAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appconfig/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppFlow::Connector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appflow/default/types.md)** | | -| **[AWS::AppFlow::ConnectorProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appflow/default/types.md)** | | -| **[AWS::AppFlow::Flow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appflow/default/types.md)** | | -| **[AWS::AppIntegrations::DataIntegration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appintegrations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppIntegrations::EventIntegration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appintegrations/default/types.md)** | | -| **[AWS::AppRunner::Service](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apprunner/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppRunner::VpcIngressConnection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apprunner/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppStream::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appstream/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppStream::DirectoryConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appstream/default/types.md)** | | -| **[AWS::AppStream::Entitlement](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appstream/default/types.md)** | | -| **[AWS::AppSync::DomainName](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appsync/default/types.md)** | | -| **[AWS::AppSync::DomainNameApiAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appsync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApplicationInsights::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.applicationinsights/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Athena::DataCatalog](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.athena/default/types.md)** | | -| **[AWS::Athena::NamedQuery](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.athena/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Athena::PreparedStatement](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.athena/default/types.md)** | | -| **[AWS::Athena::WorkGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.athena/default/types.md)** | | -| **[AWS::AuditManager::Assessment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.auditmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AutoScaling::LifecycleHook](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.autoscaling/default/types.md)** | | -| **[AWS::AutoScaling::ScalingPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.autoscaling/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AutoScaling::ScheduledAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.autoscaling/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AutoScaling::WarmPool](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.autoscaling/default/types.md)** | | -| **[AWS::Backup::BackupPlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.backup/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Backup::BackupVault](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.backup/default/types.md)** | | -| **[AWS::Backup::Framework](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.backup/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Backup::ReportPlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.backup/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Batch::ComputeEnvironment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.batch/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Batch::JobQueue](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.batch/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Batch::SchedulingPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.batch/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Budgets::BudgetsAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.budgets/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CE::CostCategory](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ce/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Cassandra::Keyspace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cassandra/default/types.md)** | | -| **[AWS::Cassandra::Table](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cassandra/default/types.md)** | | -| **[AWS::CertificateManager::Account](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.certificatemanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Chatbot::MicrosoftTeamsChannelConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.chatbot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Chatbot::SlackChannelConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.chatbot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::HookDefaultVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::HookTypeConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::ResourceDefaultVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::StackSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::TypeActivation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::CachePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::CloudFrontOriginAccessIdentity](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::ContinuousDeploymentPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::Distribution](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::Function](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::KeyGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::OriginAccessControl](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::OriginRequestPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::PublicKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::RealtimeLogConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::ResponseHeadersPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudTrail::Channel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudtrail/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudTrail::EventDataStore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudtrail/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudTrail::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudtrail/default/types.md)** | | -| **[AWS::CloudTrail::Trail](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudtrail/default/types.md)** | | -| **[AWS::CloudWatch::CompositeAlarm](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudwatch/default/types.md)** | | -| **[AWS::CloudWatch::MetricStream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudwatch/default/types.md)** | | -| **[AWS::CodeArtifact::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codeartifact/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CodeArtifact::Repository](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codeartifact/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CodeDeploy::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codedeploy/default/types.md)** | | -| **[AWS::CodeGuruProfiler::ProfilingGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codeguruprofiler/default/types.md)** | | -| **[AWS::CodePipeline::CustomActionType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codepipeline/default/types.md)** | | -| **[AWS::CodeStarConnections::Connection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codestarconnections/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CodeStarNotifications::NotificationRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codestarnotifications/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Comprehend::Flywheel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.comprehend/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Config::AggregationAuthorization](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Config::ConfigurationAggregator](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Config::ConformancePack](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Config::OrganizationConformancePack](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Config::StoredQuery](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Connect::ApprovedOrigin](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | | -| **[AWS::Connect::ContactFlow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::ContactFlowModule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::HoursOfOperation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::Instance](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::InstanceStorageConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::IntegrationAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | | -| **[AWS::Connect::PhoneNumber](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::QuickConnect](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::Rule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::SecurityKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::TaskTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::User](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::UserHierarchyGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ConnectCampaigns::Campaign](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connectcampaigns/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CustomerProfiles::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.customerprofiles/default/types.md)** | | -| **[AWS::CustomerProfiles::Integration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.customerprofiles/default/types.md)** | | -| **[AWS::CustomerProfiles::ObjectType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.customerprofiles/default/types.md)** | | -| **[AWS::DataBrew::Dataset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Job](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Recipe](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Ruleset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Schedule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataPipeline::Pipeline](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datapipeline/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::Agent](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationEFS](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationFSxLustre](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationFSxONTAP](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationFSxOpenZFS](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationFSxWindows](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationHDFS](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationNFS](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationObjectStorage](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationS3](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationSMB](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::Task](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Detective::Graph](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.detective/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Detective::MemberInvitation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.detective/default/types.md)** | | -| **[AWS::DevOpsGuru::LogAnomalyDetectionIntegration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devopsguru/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DevOpsGuru::ResourceCollection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devopsguru/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::DevicePool](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::InstanceProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::NetworkProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::TestGridProject](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::VPCEConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DirectoryService::SimpleAD](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.directoryservice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DocDBElastic::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.docdbelastic/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DynamoDB::GlobalTable](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.dynamodb/default/types.md)** | | -| **[AWS::DynamoDB::Table](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.dynamodb/default/types.md)** | | -| **[AWS::EC2::CapacityReservation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::CapacityReservationFleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::CarrierGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::CustomerGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::DHCPOptions](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::EC2Fleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::EIP](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::FlowLog](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::GatewayRouteTableAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | | -| **[AWS::EC2::Host](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAM](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAMPool](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAMResourceDiscovery](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAMResourceDiscoveryAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAMScope](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::InternetGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::LocalGatewayRoute](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | | -| **[AWS::EC2::LocalGatewayRouteTable](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::LocalGatewayRouteTableVPCAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NatGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkAcl](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInsightsAccessScope](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInsightsAccessScopeAnalysis](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInsightsAnalysis](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInsightsPath](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInterface](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::PrefixList](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::RouteTable](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::SpotFleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::Subnet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayConnect](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayMulticastDomain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayPeeringAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayVpcAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPC](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPCDHCPOptionsAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | | -| **[AWS::EC2::VPCEndpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPCEndpointService](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPCPeeringConnection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPNConnection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPNGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::Volume](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECR::PullThroughCacheRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecr/default/types.md)** | | -| **[AWS::ECR::RegistryPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecr/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECR::ReplicationConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecr/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECR::Repository](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecr/default/types.md)** | | -| **[AWS::ECS::CapacityProvider](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | | -| **[AWS::ECS::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | | -| **[AWS::ECS::ClusterCapacityProviderAssociations](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | | -| **[AWS::ECS::PrimaryTaskSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | | -| **[AWS::ECS::Service](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECS::TaskDefinition](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECS::TaskSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EFS::AccessPoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.efs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EFS::FileSystem](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.efs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EFS::MountTarget](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.efs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EKS::Addon](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | | -| **[AWS::EKS::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | | -| **[AWS::EKS::FargateProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | | -| **[AWS::EKS::IdentityProviderConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | | -| **[AWS::EKS::Nodegroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EMR::Studio](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.emr/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EMR::StudioSessionMapping](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.emr/default/types.md)** | | -| **[AWS::EMRContainers::VirtualCluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.emrcontainers/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EMRServerless::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.emrserverless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElastiCache::GlobalReplicationGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticache/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElastiCache::SubnetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticache/default/types.md)** | | -| **[AWS::ElastiCache::User](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticache/default/types.md)** | | -| **[AWS::ElastiCache::UserGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticache/default/types.md)** | | -| **[AWS::ElasticBeanstalk::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md)** | | -| **[AWS::ElasticBeanstalk::ApplicationVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElasticBeanstalk::ConfigurationTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElasticBeanstalk::Environment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md)** | | -| **[AWS::ElasticLoadBalancingV2::Listener](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElasticLoadBalancingV2::ListenerRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElasticLoadBalancingV2::TargetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EventSchemas::RegistryPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eventschemas/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Events::ApiDestination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.events/default/types.md)** | | -| **[AWS::Events::Archive](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.events/default/types.md)** | | -| **[AWS::Events::Connection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.events/default/types.md)** | | -| **[AWS::Events::Endpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.events/default/types.md)** | | -| **[AWS::Evidently::Experiment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.evidently/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Evidently::Feature](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.evidently/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Evidently::Launch](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.evidently/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Evidently::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.evidently/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FIS::ExperimentTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fis/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FMS::NotificationChannel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fms/default/types.md)** | | -| **[AWS::FMS::Policy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fms/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FMS::ResourceSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fms/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FSx::DataRepositoryAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fsx/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FinSpace::Environment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.finspace/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Forecast::DatasetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.forecast/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::Detector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::EntityType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::EventType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::Label](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::List](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::Outcome](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::Variable](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::Alias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::Build](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::Fleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::GameServerGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::Location](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | | -| **[AWS::GlobalAccelerator::Accelerator](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.globalaccelerator/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GlobalAccelerator::EndpointGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.globalaccelerator/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GlobalAccelerator::Listener](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.globalaccelerator/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Glue::Registry](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.glue/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Glue::Schema](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.glue/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Grafana::Workspace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.grafana/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GreengrassV2::ComponentVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.greengrassv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GreengrassV2::Deployment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.greengrassv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GroundStation::Config](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.groundstation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GroundStation::MissionProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.groundstation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::HealthLake::FHIRDatastore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.healthlake/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IAM::InstanceProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | | -| **[AWS::IAM::OIDCProvider](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IAM::Role](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | | -| **[AWS::IAM::SAMLProvider](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IAM::ServerCertificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | | -| **[AWS::IAM::VirtualMFADevice](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVS::Channel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVS::PlaybackKeyPair](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVS::RecordingConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVS::StreamKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVSChat::LoggingConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivschat/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVSChat::Room](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivschat/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IdentityStore::Group](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.identitystore/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ImageBuilder::DistributionConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.imagebuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ImageBuilder::ImagePipeline](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.imagebuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ImageBuilder::InfrastructureConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.imagebuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Inspector::AssessmentTarget](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.inspector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::InspectorV2::Filter](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.inspectorv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::InternetMonitor::Monitor](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.internetmonitor/default/types.md)** | | -| **[AWS::IoT::AccountAuditConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Authorizer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::CACertificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoT::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoT::CustomMetric](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Dimension](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::DomainConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::FleetMetric](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Logging](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::MitigationAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Policy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoT::ProvisioningTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::ResourceSpecificLogging](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoT::RoleAlias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::ScheduledAudit](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::SecurityProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Thing](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::TopicRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::TopicRuleDestination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTAnalytics::Channel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotanalytics/default/types.md)** | | -| **[AWS::IoTAnalytics::Dataset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotanalytics/default/types.md)** | | -| **[AWS::IoTAnalytics::Datastore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotanalytics/default/types.md)** | | -| **[AWS::IoTAnalytics::Pipeline](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotanalytics/default/types.md)** | | -| **[AWS::IoTCoreDeviceAdvisor::SuiteDefinition](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTEvents::AlarmModel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotevents/default/types.md)** | | -| **[AWS::IoTEvents::DetectorModel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotevents/default/types.md)** | | -| **[AWS::IoTEvents::Input](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotevents/default/types.md)** | | -| **[AWS::IoTFleetHub::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotfleethub/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::AccessPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Asset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::AssetModel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Dashboard](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Gateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Portal](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTTwinMaker::ComponentType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iottwinmaker/default/types.md)** | | -| **[AWS::IoTTwinMaker::Entity](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iottwinmaker/default/types.md)** | | -| **[AWS::IoTTwinMaker::Scene](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iottwinmaker/default/types.md)** | | -| **[AWS::IoTTwinMaker::Workspace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iottwinmaker/default/types.md)** | | -| **[AWS::IoTWireless::Destination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | | -| **[AWS::IoTWireless::FuotaTask](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTWireless::MulticastGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTWireless::NetworkAnalyzerConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | | -| **[AWS::IoTWireless::WirelessDevice](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTWireless::WirelessGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::KMS::Alias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kms/default/types.md)** | | -| **[AWS::KMS::Key](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kms/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::KMS::ReplicaKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kms/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::KafkaConnect::Connector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kafkaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Kendra::DataSource](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kendra/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Kendra::Faq](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kendra/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Kendra::Index](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kendra/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::KendraRanking::ExecutionPlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kendraranking/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Kinesis::Stream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesis/default/types.md)** | | -| **[AWS::KinesisAnalyticsV2::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.md)** | | -| **[AWS::KinesisFirehose::DeliveryStream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesisfirehose/default/types.md)** | | -| **[AWS::KinesisVideo::SignalingChannel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesisvideo/default/types.md)** | | -| **[AWS::KinesisVideo::Stream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesisvideo/default/types.md)** | | -| **[AWS::LakeFormation::Tag](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lakeformation/default/types.md)** | | -| **[AWS::Lambda::CodeSigningConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lambda/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lambda::EventSourceMapping](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lambda/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lambda::Function](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lambda/default/types.md)** | | -| **[AWS::Lambda::Url](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lambda/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lex::Bot](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lex/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lex::BotAlias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lex/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lex::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lex/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::LicenseManager::Grant](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.licensemanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::LicenseManager::License](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.licensemanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lightsail::Alarm](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Bucket](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Container](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Database](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Disk](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Instance](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::LoadBalancer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::LoadBalancerTlsCertificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::StaticIp](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Logs::Destination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::Logs::LogGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::Logs::MetricFilter](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::Logs::QueryDefinition](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Logs::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::Logs::SubscriptionFilter](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::LookoutMetrics::AnomalyDetector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lookoutmetrics/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::LookoutVision::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lookoutvision/default/types.md)** | | -| **[AWS::M2::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.m2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::M2::Environment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.m2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MSK::BatchScramSecret](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.msk/default/types.md)** | | -| **[AWS::MSK::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.msk/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MSK::Configuration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.msk/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MWAA::Environment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mwaa/default/types.md)** | | -| **[AWS::Macie::AllowList](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.macie/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Macie::CustomDataIdentifier](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.macie/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Macie::FindingsFilter](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.macie/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Macie::Session](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.macie/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::Flow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::FlowEntitlement](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::FlowOutput](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::FlowSource](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::FlowVpcInterface](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | | -| **[AWS::MediaPackage::Channel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediapackage/default/types.md)** | | -| **[AWS::MediaPackage::OriginEndpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediapackage/default/types.md)** | | -| **[AWS::MediaPackage::PackagingGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediapackage/default/types.md)** | | -| **[AWS::MediaTailor::PlaybackConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediatailor/default/types.md)** | | -| **[AWS::MemoryDB::ACL](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::MemoryDB::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::MemoryDB::ParameterGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::MemoryDB::SubnetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::MemoryDB::User](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::Neptune::DBCluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.neptune/default/types.md)** | | -| **[AWS::NetworkFirewall::Firewall](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkfirewall/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkFirewall::FirewallPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkfirewall/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkFirewall::LoggingConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkfirewall/default/types.md)** | | -| **[AWS::NetworkFirewall::RuleGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkfirewall/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::ConnectAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::ConnectPeer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::CoreNetwork](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::Device](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::GlobalNetwork](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::Link](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::Site](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::SiteToSiteVpnAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::TransitGatewayPeering](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::TransitGatewayRouteTableAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::VpcAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NimbleStudio::LaunchProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.nimblestudio/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NimbleStudio::StreamingImage](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.nimblestudio/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NimbleStudio::Studio](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.nimblestudio/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NimbleStudio::StudioComponent](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.nimblestudio/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Oam::Link](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.oam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Oam::Sink](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.oam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Omics::AnnotationStore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.omics/default/types.md)** | | -| **[AWS::Omics::RunGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.omics/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Omics::VariantStore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.omics/default/types.md)** | | -| **[AWS::Omics::Workflow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.omics/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::OpenSearchServerless::AccessPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | | -| **[AWS::OpenSearchServerless::Collection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::OpenSearchServerless::SecurityConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::OpenSearchServerless::SecurityPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | | -| **[AWS::OpenSearchServerless::VpcEndpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::OpenSearchService::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchservice/default/types.md)** | | -| **[AWS::OpsWorksCM::Server](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opsworkscm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Organizations::Account](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.organizations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Organizations::OrganizationalUnit](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.organizations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Organizations::Policy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.organizations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Organizations::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.organizations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Panorama::ApplicationInstance](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.panorama/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Panorama::Package](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.panorama/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Panorama::PackageVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.panorama/default/types.md)** | | -| **[AWS::Personalize::Dataset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.personalize/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Pinpoint::InAppTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.pinpoint/default/types.md)** | | -| **[AWS::Pipes::Pipe](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.pipes/default/types.md)** | | -| **[AWS::QLDB::Stream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.qldb/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::QuickSight::Analysis](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::Dashboard](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::DataSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::DataSource](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::RefreshSchedule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::Template](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::Theme](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::RAM::Permission](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ram/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RDS::DBCluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBClusterParameterGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBInstance](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBParameterGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBProxy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBProxyEndpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBProxyTargetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RDS::DBSubnetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::EventSubscription](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::GlobalCluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::OptionGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RUM::AppMonitor](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rum/default/types.md)** | | -| **[AWS::Redshift::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::ClusterParameterGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::ClusterSubnetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Redshift::EndpointAccess](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::EndpointAuthorization](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::EventSubscription](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::ScheduledAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::RedshiftServerless::Namespace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshiftserverless/default/types.md)** | | -| **[AWS::RedshiftServerless::Workgroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshiftserverless/default/types.md)** | | -| **[AWS::RefactorSpaces::Route](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.refactorspaces/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Rekognition::Collection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rekognition/default/types.md)** | | -| **[AWS::Rekognition::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rekognition/default/types.md)** | | -| **[AWS::Rekognition::StreamProcessor](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rekognition/default/types.md)** | | -| **[AWS::ResilienceHub::App](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resiliencehub/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResilienceHub::ResiliencyPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resiliencehub/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResourceExplorer2::DefaultViewAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResourceExplorer2::Index](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResourceExplorer2::View](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResourceGroups::Group](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resourcegroups/default/types.md)** | | -| **[AWS::RoboMaker::Fleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.robomaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RoboMaker::Robot](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.robomaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RoboMaker::RobotApplication](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.robomaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RoboMaker::SimulationApplication](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.robomaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RolesAnywhere::CRL](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rolesanywhere/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RolesAnywhere::Profile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rolesanywhere/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RolesAnywhere::TrustAnchor](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rolesanywhere/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53::CidrCollection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53::HealthCheck](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53::HostedZone](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53::KeySigningKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53/default/types.md)** | | -| **[AWS::Route53RecoveryControl::ControlPanel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53RecoveryControl::RoutingControl](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53RecoveryControl::SafetyRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53RecoveryReadiness::Cell](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md)** | | -| **[AWS::Route53RecoveryReadiness::ReadinessCheck](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md)** | | -| **[AWS::Route53RecoveryReadiness::RecoveryGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md)** | | -| **[AWS::Route53RecoveryReadiness::ResourceSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md)** | | -| **[AWS::Route53Resolver::FirewallDomainList](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53resolver/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53Resolver::FirewallRuleGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53resolver/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53Resolver::FirewallRuleGroupAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53resolver/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53Resolver::ResolverRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53resolver/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::S3::AccessPoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::S3::Bucket](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3/default/types.md)** | | -| **[AWS::S3::MultiRegionAccessPointPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3/default/types.md)** | | -| **[AWS::S3::StorageLens](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3/default/types.md)** | | -| **[AWS::S3ObjectLambda::AccessPoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3objectlambda/default/types.md)** | | -| **[AWS::S3ObjectLambda::AccessPointPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3objectlambda/default/types.md)** | | -| **[AWS::S3Outposts::AccessPoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3outposts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::S3Outposts::Bucket](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3outposts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::S3Outposts::BucketPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3outposts/default/types.md)** | | -| **[AWS::SES::ConfigurationSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | | -| **[AWS::SES::ConfigurationSetEventDestination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SES::ContactList](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | | -| **[AWS::SES::EmailIdentity](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | | -| **[AWS::SES::Template](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SES::VdmAttributes](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SNS::Topic](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sns/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SQS::Queue](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sqs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSM::Association](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSM::Document](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssm/default/types.md)** | | -| **[AWS::SSM::ResourceDataSync](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSM::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMContacts::Contact](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmcontacts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMContacts::ContactChannel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmcontacts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMContacts::Plan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmcontacts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMContacts::Rotation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmcontacts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMIncidents::ReplicationSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmincidents/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMIncidents::ResponsePlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmincidents/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSO::InstanceAccessControlAttributeConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sso/default/types.md)** | | -| **[AWS::SSO::PermissionSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sso/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::AppImageConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::Device](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::DeviceFleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::FeatureGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::Image](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::InferenceExperiment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::ModelCard](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::ModelPackage](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::ModelPackageGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::MonitoringSchedule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::Pipeline](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::Space](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::UserProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::Scheduler::Schedule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.scheduler/default/types.md)** | | -| **[AWS::Scheduler::ScheduleGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.scheduler/default/types.md)** | | -| **[AWS::ServiceCatalog::CloudFormationProvisionedProduct](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.servicecatalog/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ServiceCatalog::ServiceAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.servicecatalog/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ServiceCatalogAppRegistry::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ServiceCatalogAppRegistry::AttributeGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Signer::SigningProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.signer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SimSpaceWeaver::Simulation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.simspaceweaver/default/types.md)** | | -| **[AWS::StepFunctions::Activity](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.stepfunctions/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::StepFunctions::StateMachine](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.stepfunctions/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SupportApp::AccountAlias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.supportapp/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SupportApp::SlackChannelConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.supportapp/default/types.md)** | | -| **[AWS::SupportApp::SlackWorkspaceConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.supportapp/default/types.md)** | | -| **[AWS::Synthetics::Canary](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.synthetics/default/types.md)** | | -| **[AWS::Synthetics::Group](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.synthetics/default/types.md)** | | -| **[AWS::SystemsManagerSAP::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.systemsmanagersap/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Timestream::Database](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.timestream/default/types.md)** | | -| **[AWS::Timestream::ScheduledQuery](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.timestream/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Timestream::Table](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.timestream/default/types.md)** | | -| **[AWS::Transfer::Agreement](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Transfer::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Transfer::Connector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Transfer::Profile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Transfer::Workflow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VoiceID::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.voiceid/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::AccessLogSubscription](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::AuthPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | | -| **[AWS::VpcLattice::Listener](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | | -| **[AWS::VpcLattice::Rule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::Service](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::ServiceNetwork](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::ServiceNetworkServiceAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::ServiceNetworkVpcAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::TargetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::IPSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::LoggingConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | | -| **[AWS::WAFv2::RegexPatternSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::RuleGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::WebACL](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::WebACLAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | | -| **[AWS::Wisdom::KnowledgeBase](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wisdom/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::XRay::Group](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.xray/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::XRay::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.xray/default/types.md)** | | -| **[AWS::XRay::SamplingRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.xray/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | ---- -type: docs -title: "Supported AWS resources" -linkTitle: "Supported AWS resources " -description: "Learn about the supported AWS resource types in Radius" -categories: "Schema" ---- - -Radius supports AWS resource types that are supported by the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html) - -Following table lists the resource types that are currently supported and the limitations for each of the resource types. - -| Resource Type | Notes | -| ------------- | ----- | -| **[AWS::ACMPCA::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.acmpca/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ACMPCA::CertificateAuthority](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.acmpca/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ACMPCA::CertificateAuthorityActivation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.acmpca/default/types.md)** | | -| **[AWS::APS::RuleGroupsNamespace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.aps/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::APS::Workspace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.aps/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AccessAnalyzer::Analyzer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.accessanalyzer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Amplify::App](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplify/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Amplify::Branch](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplify/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Amplify::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplify/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AmplifyUIBuilder::Component](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AmplifyUIBuilder::Form](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AmplifyUIBuilder::Theme](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Account](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::ApiKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Authorizer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::BasePathMapping](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::ClientCertificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Deployment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::DocumentationPart](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::DocumentationVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::DomainName](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::Method](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::Model](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::RequestValidator](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Resource](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::RestApi](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::Stage](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | | -| **[AWS::ApiGateway::UsagePlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGateway::VpcLink](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigateway/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Api](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Authorizer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Deployment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Model](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::Route](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApiGatewayV2::VpcLink](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apigatewayv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppConfig::Extension](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appconfig/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppConfig::ExtensionAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appconfig/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppFlow::Connector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appflow/default/types.md)** | | -| **[AWS::AppFlow::ConnectorProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appflow/default/types.md)** | | -| **[AWS::AppFlow::Flow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appflow/default/types.md)** | | -| **[AWS::AppIntegrations::DataIntegration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appintegrations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppIntegrations::EventIntegration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appintegrations/default/types.md)** | | -| **[AWS::AppRunner::Service](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apprunner/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppRunner::VpcIngressConnection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.apprunner/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppStream::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appstream/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AppStream::DirectoryConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appstream/default/types.md)** | | -| **[AWS::AppStream::Entitlement](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appstream/default/types.md)** | | -| **[AWS::AppSync::DomainName](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appsync/default/types.md)** | | -| **[AWS::AppSync::DomainNameApiAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.appsync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ApplicationInsights::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.applicationinsights/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Athena::DataCatalog](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.athena/default/types.md)** | | -| **[AWS::Athena::NamedQuery](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.athena/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Athena::PreparedStatement](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.athena/default/types.md)** | | -| **[AWS::Athena::WorkGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.athena/default/types.md)** | | -| **[AWS::AuditManager::Assessment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.auditmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AutoScaling::LifecycleHook](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.autoscaling/default/types.md)** | | -| **[AWS::AutoScaling::ScalingPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.autoscaling/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AutoScaling::ScheduledAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.autoscaling/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::AutoScaling::WarmPool](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.autoscaling/default/types.md)** | | -| **[AWS::Backup::BackupPlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.backup/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Backup::BackupVault](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.backup/default/types.md)** | | -| **[AWS::Backup::Framework](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.backup/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Backup::ReportPlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.backup/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Batch::ComputeEnvironment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.batch/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Batch::JobQueue](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.batch/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Batch::SchedulingPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.batch/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Budgets::BudgetsAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.budgets/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CE::CostCategory](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ce/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Cassandra::Keyspace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cassandra/default/types.md)** | | -| **[AWS::Cassandra::Table](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cassandra/default/types.md)** | | -| **[AWS::CertificateManager::Account](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.certificatemanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Chatbot::MicrosoftTeamsChannelConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.chatbot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Chatbot::SlackChannelConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.chatbot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::HookDefaultVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::HookTypeConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::ResourceDefaultVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::StackSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFormation::TypeActivation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudformation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::CachePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::CloudFrontOriginAccessIdentity](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::ContinuousDeploymentPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::Distribution](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::Function](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::KeyGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::OriginAccessControl](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::OriginRequestPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::PublicKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::RealtimeLogConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudFront::ResponseHeadersPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudfront/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudTrail::Channel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudtrail/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudTrail::EventDataStore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudtrail/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CloudTrail::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudtrail/default/types.md)** | | -| **[AWS::CloudTrail::Trail](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudtrail/default/types.md)** | | -| **[AWS::CloudWatch::CompositeAlarm](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudwatch/default/types.md)** | | -| **[AWS::CloudWatch::MetricStream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.cloudwatch/default/types.md)** | | -| **[AWS::CodeArtifact::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codeartifact/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CodeArtifact::Repository](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codeartifact/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CodeDeploy::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codedeploy/default/types.md)** | | -| **[AWS::CodeGuruProfiler::ProfilingGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codeguruprofiler/default/types.md)** | | -| **[AWS::CodePipeline::CustomActionType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codepipeline/default/types.md)** | | -| **[AWS::CodeStarConnections::Connection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codestarconnections/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CodeStarNotifications::NotificationRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.codestarnotifications/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Comprehend::Flywheel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.comprehend/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Config::AggregationAuthorization](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Config::ConfigurationAggregator](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Config::ConformancePack](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Config::OrganizationConformancePack](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Config::StoredQuery](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.config/default/types.md)** | | -| **[AWS::Connect::ApprovedOrigin](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | | -| **[AWS::Connect::ContactFlow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::ContactFlowModule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::HoursOfOperation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::Instance](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::InstanceStorageConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::IntegrationAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | | -| **[AWS::Connect::PhoneNumber](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::QuickConnect](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::Rule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::SecurityKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::TaskTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::User](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Connect::UserHierarchyGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ConnectCampaigns::Campaign](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.connectcampaigns/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::CustomerProfiles::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.customerprofiles/default/types.md)** | | -| **[AWS::CustomerProfiles::Integration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.customerprofiles/default/types.md)** | | -| **[AWS::CustomerProfiles::ObjectType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.customerprofiles/default/types.md)** | | -| **[AWS::DataBrew::Dataset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Job](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Recipe](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Ruleset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataBrew::Schedule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.databrew/default/types.md)** | | -| **[AWS::DataPipeline::Pipeline](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datapipeline/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::Agent](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationEFS](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationFSxLustre](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationFSxONTAP](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationFSxOpenZFS](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationFSxWindows](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationHDFS](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationNFS](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationObjectStorage](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationS3](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::LocationSMB](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DataSync::Task](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.datasync/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Detective::Graph](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.detective/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Detective::MemberInvitation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.detective/default/types.md)** | | -| **[AWS::DevOpsGuru::LogAnomalyDetectionIntegration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devopsguru/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DevOpsGuru::ResourceCollection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devopsguru/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::DevicePool](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::InstanceProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::NetworkProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::TestGridProject](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DeviceFarm::VPCEConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.devicefarm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DirectoryService::SimpleAD](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.directoryservice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DocDBElastic::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.docdbelastic/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::DynamoDB::GlobalTable](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.dynamodb/default/types.md)** | | -| **[AWS::DynamoDB::Table](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.dynamodb/default/types.md)** | | -| **[AWS::EC2::CapacityReservation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::CapacityReservationFleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::CarrierGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::CustomerGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::DHCPOptions](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::EC2Fleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::EIP](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::FlowLog](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::GatewayRouteTableAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | | -| **[AWS::EC2::Host](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAM](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAMPool](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAMResourceDiscovery](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAMResourceDiscoveryAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::IPAMScope](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::InternetGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::LocalGatewayRoute](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | | -| **[AWS::EC2::LocalGatewayRouteTable](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::LocalGatewayRouteTableVPCAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NatGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkAcl](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInsightsAccessScope](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInsightsAccessScopeAnalysis](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInsightsAnalysis](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInsightsPath](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::NetworkInterface](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::PrefixList](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::RouteTable](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::SpotFleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::Subnet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayConnect](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayMulticastDomain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayPeeringAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::TransitGatewayVpcAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPC](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPCDHCPOptionsAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | | -| **[AWS::EC2::VPCEndpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPCEndpointService](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPCPeeringConnection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPNConnection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::VPNGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EC2::Volume](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ec2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECR::PullThroughCacheRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecr/default/types.md)** | | -| **[AWS::ECR::RegistryPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecr/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECR::ReplicationConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecr/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECR::Repository](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecr/default/types.md)** | | -| **[AWS::ECS::CapacityProvider](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | | -| **[AWS::ECS::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | | -| **[AWS::ECS::ClusterCapacityProviderAssociations](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | | -| **[AWS::ECS::PrimaryTaskSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | | -| **[AWS::ECS::Service](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECS::TaskDefinition](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ECS::TaskSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ecs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EFS::AccessPoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.efs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EFS::FileSystem](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.efs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EFS::MountTarget](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.efs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EKS::Addon](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | | -| **[AWS::EKS::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | | -| **[AWS::EKS::FargateProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | | -| **[AWS::EKS::IdentityProviderConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | | -| **[AWS::EKS::Nodegroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eks/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EMR::Studio](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.emr/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EMR::StudioSessionMapping](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.emr/default/types.md)** | | -| **[AWS::EMRContainers::VirtualCluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.emrcontainers/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EMRServerless::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.emrserverless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElastiCache::GlobalReplicationGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticache/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElastiCache::SubnetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticache/default/types.md)** | | -| **[AWS::ElastiCache::User](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticache/default/types.md)** | | -| **[AWS::ElastiCache::UserGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticache/default/types.md)** | | -| **[AWS::ElasticBeanstalk::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md)** | | -| **[AWS::ElasticBeanstalk::ApplicationVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElasticBeanstalk::ConfigurationTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElasticBeanstalk::Environment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md)** | | -| **[AWS::ElasticLoadBalancingV2::Listener](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElasticLoadBalancingV2::ListenerRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ElasticLoadBalancingV2::TargetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::EventSchemas::RegistryPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.eventschemas/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Events::ApiDestination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.events/default/types.md)** | | -| **[AWS::Events::Archive](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.events/default/types.md)** | | -| **[AWS::Events::Connection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.events/default/types.md)** | | -| **[AWS::Events::Endpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.events/default/types.md)** | | -| **[AWS::Evidently::Experiment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.evidently/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Evidently::Feature](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.evidently/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Evidently::Launch](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.evidently/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Evidently::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.evidently/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FIS::ExperimentTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fis/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FMS::NotificationChannel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fms/default/types.md)** | | -| **[AWS::FMS::Policy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fms/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FMS::ResourceSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fms/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FSx::DataRepositoryAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.fsx/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FinSpace::Environment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.finspace/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Forecast::DatasetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.forecast/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::Detector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::EntityType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::EventType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::Label](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::List](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::Outcome](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::FraudDetector::Variable](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.frauddetector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::Alias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::Build](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::Fleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::GameServerGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GameLift::Location](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.gamelift/default/types.md)** | | -| **[AWS::GlobalAccelerator::Accelerator](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.globalaccelerator/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GlobalAccelerator::EndpointGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.globalaccelerator/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GlobalAccelerator::Listener](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.globalaccelerator/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Glue::Registry](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.glue/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Glue::Schema](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.glue/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Grafana::Workspace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.grafana/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GreengrassV2::ComponentVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.greengrassv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GreengrassV2::Deployment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.greengrassv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GroundStation::Config](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.groundstation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::GroundStation::MissionProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.groundstation/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::HealthLake::FHIRDatastore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.healthlake/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IAM::InstanceProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | | -| **[AWS::IAM::OIDCProvider](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IAM::Role](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | | -| **[AWS::IAM::SAMLProvider](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IAM::ServerCertificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | | -| **[AWS::IAM::VirtualMFADevice](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVS::Channel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVS::PlaybackKeyPair](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVS::RecordingConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVS::StreamKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVSChat::LoggingConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivschat/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IVSChat::Room](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ivschat/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IdentityStore::Group](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.identitystore/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ImageBuilder::DistributionConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.imagebuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ImageBuilder::ImagePipeline](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.imagebuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ImageBuilder::InfrastructureConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.imagebuilder/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Inspector::AssessmentTarget](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.inspector/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::InspectorV2::Filter](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.inspectorv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::InternetMonitor::Monitor](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.internetmonitor/default/types.md)** | | -| **[AWS::IoT::AccountAuditConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Authorizer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::CACertificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoT::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoT::CustomMetric](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Dimension](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::DomainConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::FleetMetric](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Logging](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::MitigationAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Policy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoT::ProvisioningTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::ResourceSpecificLogging](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoT::RoleAlias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::ScheduledAudit](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::SecurityProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::Thing](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::TopicRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | | -| **[AWS::IoT::TopicRuleDestination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iot/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTAnalytics::Channel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotanalytics/default/types.md)** | | -| **[AWS::IoTAnalytics::Dataset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotanalytics/default/types.md)** | | -| **[AWS::IoTAnalytics::Datastore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotanalytics/default/types.md)** | | -| **[AWS::IoTAnalytics::Pipeline](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotanalytics/default/types.md)** | | -| **[AWS::IoTCoreDeviceAdvisor::SuiteDefinition](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTEvents::AlarmModel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotevents/default/types.md)** | | -| **[AWS::IoTEvents::DetectorModel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotevents/default/types.md)** | | -| **[AWS::IoTEvents::Input](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotevents/default/types.md)** | | -| **[AWS::IoTFleetHub::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotfleethub/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::AccessPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Asset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::AssetModel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Dashboard](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Gateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Portal](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTSiteWise::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotsitewise/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTTwinMaker::ComponentType](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iottwinmaker/default/types.md)** | | -| **[AWS::IoTTwinMaker::Entity](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iottwinmaker/default/types.md)** | | -| **[AWS::IoTTwinMaker::Scene](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iottwinmaker/default/types.md)** | | -| **[AWS::IoTTwinMaker::Workspace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iottwinmaker/default/types.md)** | | -| **[AWS::IoTWireless::Destination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | | -| **[AWS::IoTWireless::FuotaTask](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTWireless::MulticastGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTWireless::NetworkAnalyzerConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | | -| **[AWS::IoTWireless::WirelessDevice](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::IoTWireless::WirelessGateway](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.iotwireless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::KMS::Alias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kms/default/types.md)** | | -| **[AWS::KMS::Key](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kms/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::KMS::ReplicaKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kms/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::KafkaConnect::Connector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kafkaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Kendra::DataSource](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kendra/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Kendra::Faq](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kendra/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Kendra::Index](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kendra/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::KendraRanking::ExecutionPlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kendraranking/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Kinesis::Stream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesis/default/types.md)** | | -| **[AWS::KinesisAnalyticsV2::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.md)** | | -| **[AWS::KinesisFirehose::DeliveryStream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesisfirehose/default/types.md)** | | -| **[AWS::KinesisVideo::SignalingChannel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesisvideo/default/types.md)** | | -| **[AWS::KinesisVideo::Stream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.kinesisvideo/default/types.md)** | | -| **[AWS::LakeFormation::Tag](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lakeformation/default/types.md)** | | -| **[AWS::Lambda::CodeSigningConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lambda/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lambda::EventSourceMapping](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lambda/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lambda::Function](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lambda/default/types.md)** | | -| **[AWS::Lambda::Url](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lambda/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lex::Bot](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lex/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lex::BotAlias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lex/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lex::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lex/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::LicenseManager::Grant](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.licensemanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::LicenseManager::License](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.licensemanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Lightsail::Alarm](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Bucket](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Container](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Database](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Disk](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::Instance](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::LoadBalancer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::LoadBalancerTlsCertificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Lightsail::StaticIp](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lightsail/default/types.md)** | | -| **[AWS::Logs::Destination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::Logs::LogGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::Logs::MetricFilter](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::Logs::QueryDefinition](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Logs::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::Logs::SubscriptionFilter](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.logs/default/types.md)** | | -| **[AWS::LookoutMetrics::AnomalyDetector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lookoutmetrics/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::LookoutVision::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.lookoutvision/default/types.md)** | | -| **[AWS::M2::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.m2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::M2::Environment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.m2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MSK::BatchScramSecret](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.msk/default/types.md)** | | -| **[AWS::MSK::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.msk/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MSK::Configuration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.msk/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MWAA::Environment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mwaa/default/types.md)** | | -| **[AWS::Macie::AllowList](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.macie/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Macie::CustomDataIdentifier](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.macie/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Macie::FindingsFilter](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.macie/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Macie::Session](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.macie/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::Flow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::FlowEntitlement](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::FlowOutput](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::FlowSource](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::MediaConnect::FlowVpcInterface](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediaconnect/default/types.md)** | | -| **[AWS::MediaPackage::Channel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediapackage/default/types.md)** | | -| **[AWS::MediaPackage::OriginEndpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediapackage/default/types.md)** | | -| **[AWS::MediaPackage::PackagingGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediapackage/default/types.md)** | | -| **[AWS::MediaTailor::PlaybackConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.mediatailor/default/types.md)** | | -| **[AWS::MemoryDB::ACL](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::MemoryDB::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::MemoryDB::ParameterGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::MemoryDB::SubnetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::MemoryDB::User](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.memorydb/default/types.md)** | | -| **[AWS::Neptune::DBCluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.neptune/default/types.md)** | | -| **[AWS::NetworkFirewall::Firewall](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkfirewall/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkFirewall::FirewallPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkfirewall/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkFirewall::LoggingConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkfirewall/default/types.md)** | | -| **[AWS::NetworkFirewall::RuleGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkfirewall/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::ConnectAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::ConnectPeer](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::CoreNetwork](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::Device](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::GlobalNetwork](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::Link](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::Site](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::SiteToSiteVpnAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::TransitGatewayPeering](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::TransitGatewayRouteTableAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NetworkManager::VpcAttachment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.networkmanager/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NimbleStudio::LaunchProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.nimblestudio/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NimbleStudio::StreamingImage](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.nimblestudio/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NimbleStudio::Studio](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.nimblestudio/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::NimbleStudio::StudioComponent](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.nimblestudio/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Oam::Link](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.oam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Oam::Sink](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.oam/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Omics::AnnotationStore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.omics/default/types.md)** | | -| **[AWS::Omics::RunGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.omics/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Omics::VariantStore](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.omics/default/types.md)** | | -| **[AWS::Omics::Workflow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.omics/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::OpenSearchServerless::AccessPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | | -| **[AWS::OpenSearchServerless::Collection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::OpenSearchServerless::SecurityConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::OpenSearchServerless::SecurityPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | | -| **[AWS::OpenSearchServerless::VpcEndpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchserverless/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::OpenSearchService::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opensearchservice/default/types.md)** | | -| **[AWS::OpsWorksCM::Server](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.opsworkscm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Organizations::Account](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.organizations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Organizations::OrganizationalUnit](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.organizations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Organizations::Policy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.organizations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Organizations::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.organizations/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Panorama::ApplicationInstance](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.panorama/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Panorama::Package](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.panorama/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Panorama::PackageVersion](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.panorama/default/types.md)** | | -| **[AWS::Personalize::Dataset](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.personalize/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Pinpoint::InAppTemplate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.pinpoint/default/types.md)** | | -| **[AWS::Pipes::Pipe](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.pipes/default/types.md)** | | -| **[AWS::QLDB::Stream](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.qldb/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::QuickSight::Analysis](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::Dashboard](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::DataSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::DataSource](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::RefreshSchedule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::Template](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::QuickSight::Theme](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.quicksight/default/types.md)** | | -| **[AWS::RAM::Permission](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ram/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RDS::DBCluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBClusterParameterGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBInstance](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBParameterGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBProxy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBProxyEndpoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::DBProxyTargetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RDS::DBSubnetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::EventSubscription](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::GlobalCluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RDS::OptionGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rds/default/types.md)** | | -| **[AWS::RUM::AppMonitor](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rum/default/types.md)** | | -| **[AWS::Redshift::Cluster](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::ClusterParameterGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::ClusterSubnetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Redshift::EndpointAccess](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::EndpointAuthorization](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::EventSubscription](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::Redshift::ScheduledAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshift/default/types.md)** | | -| **[AWS::RedshiftServerless::Namespace](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshiftserverless/default/types.md)** | | -| **[AWS::RedshiftServerless::Workgroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.redshiftserverless/default/types.md)** | | -| **[AWS::RefactorSpaces::Route](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.refactorspaces/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Rekognition::Collection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rekognition/default/types.md)** | | -| **[AWS::Rekognition::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rekognition/default/types.md)** | | -| **[AWS::Rekognition::StreamProcessor](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rekognition/default/types.md)** | | -| **[AWS::ResilienceHub::App](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resiliencehub/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResilienceHub::ResiliencyPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resiliencehub/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResourceExplorer2::DefaultViewAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResourceExplorer2::Index](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResourceExplorer2::View](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ResourceGroups::Group](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.resourcegroups/default/types.md)** | | -| **[AWS::RoboMaker::Fleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.robomaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RoboMaker::Robot](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.robomaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RoboMaker::RobotApplication](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.robomaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RoboMaker::SimulationApplication](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.robomaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RolesAnywhere::CRL](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rolesanywhere/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RolesAnywhere::Profile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rolesanywhere/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::RolesAnywhere::TrustAnchor](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.rolesanywhere/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53::CidrCollection](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53::HealthCheck](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53::HostedZone](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53::KeySigningKey](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53/default/types.md)** | | -| **[AWS::Route53RecoveryControl::ControlPanel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53RecoveryControl::RoutingControl](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53RecoveryControl::SafetyRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53RecoveryReadiness::Cell](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md)** | | -| **[AWS::Route53RecoveryReadiness::ReadinessCheck](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md)** | | -| **[AWS::Route53RecoveryReadiness::RecoveryGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md)** | | -| **[AWS::Route53RecoveryReadiness::ResourceSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md)** | | -| **[AWS::Route53Resolver::FirewallDomainList](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53resolver/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53Resolver::FirewallRuleGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53resolver/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53Resolver::FirewallRuleGroupAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53resolver/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Route53Resolver::ResolverRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.route53resolver/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::S3::AccessPoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::S3::Bucket](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3/default/types.md)** | | -| **[AWS::S3::MultiRegionAccessPointPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3/default/types.md)** | | -| **[AWS::S3::StorageLens](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3/default/types.md)** | | -| **[AWS::S3ObjectLambda::AccessPoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3objectlambda/default/types.md)** | | -| **[AWS::S3ObjectLambda::AccessPointPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3objectlambda/default/types.md)** | | -| **[AWS::S3Outposts::AccessPoint](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3outposts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::S3Outposts::Bucket](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3outposts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::S3Outposts::BucketPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.s3outposts/default/types.md)** | | -| **[AWS::SES::ConfigurationSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | | -| **[AWS::SES::ConfigurationSetEventDestination](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SES::ContactList](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | | -| **[AWS::SES::EmailIdentity](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | | -| **[AWS::SES::Template](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SES::VdmAttributes](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ses/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SNS::Topic](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sns/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SQS::Queue](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sqs/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSM::Association](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSM::Document](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssm/default/types.md)** | | -| **[AWS::SSM::ResourceDataSync](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSM::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssm/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMContacts::Contact](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmcontacts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMContacts::ContactChannel](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmcontacts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMContacts::Plan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmcontacts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMContacts::Rotation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmcontacts/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMIncidents::ReplicationSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmincidents/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSMIncidents::ResponsePlan](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.ssmincidents/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SSO::InstanceAccessControlAttributeConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sso/default/types.md)** | | -| **[AWS::SSO::PermissionSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sso/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::AppImageConfig](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::Device](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::DeviceFleet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::FeatureGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::Image](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::InferenceExperiment](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::ModelCard](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::ModelPackage](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::ModelPackageGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::MonitoringSchedule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::Pipeline](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::Project](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SageMaker::Space](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::SageMaker::UserProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.sagemaker/default/types.md)** | | -| **[AWS::Scheduler::Schedule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.scheduler/default/types.md)** | | -| **[AWS::Scheduler::ScheduleGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.scheduler/default/types.md)** | | -| **[AWS::ServiceCatalog::CloudFormationProvisionedProduct](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.servicecatalog/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ServiceCatalog::ServiceAction](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.servicecatalog/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ServiceCatalogAppRegistry::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::ServiceCatalogAppRegistry::AttributeGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Signer::SigningProfile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.signer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SimSpaceWeaver::Simulation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.simspaceweaver/default/types.md)** | | -| **[AWS::StepFunctions::Activity](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.stepfunctions/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::StepFunctions::StateMachine](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.stepfunctions/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SupportApp::AccountAlias](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.supportapp/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::SupportApp::SlackChannelConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.supportapp/default/types.md)** | | -| **[AWS::SupportApp::SlackWorkspaceConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.supportapp/default/types.md)** | | -| **[AWS::Synthetics::Canary](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.synthetics/default/types.md)** | | -| **[AWS::Synthetics::Group](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.synthetics/default/types.md)** | | -| **[AWS::SystemsManagerSAP::Application](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.systemsmanagersap/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Timestream::Database](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.timestream/default/types.md)** | | -| **[AWS::Timestream::ScheduledQuery](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.timestream/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Timestream::Table](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.timestream/default/types.md)** | | -| **[AWS::Transfer::Agreement](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Transfer::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Transfer::Connector](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Transfer::Profile](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::Transfer::Workflow](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.transfer/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VoiceID::Domain](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.voiceid/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::AccessLogSubscription](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::AuthPolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | | -| **[AWS::VpcLattice::Listener](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | | -| **[AWS::VpcLattice::Rule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::Service](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::ServiceNetwork](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::ServiceNetworkServiceAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::ServiceNetworkVpcAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::VpcLattice::TargetGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.vpclattice/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::IPSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::LoggingConfiguration](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | | -| **[AWS::WAFv2::RegexPatternSet](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::RuleGroup](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::WebACL](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::WAFv2::WebACLAssociation](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wafv2/default/types.md)** | | -| **[AWS::Wisdom::KnowledgeBase](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.wisdom/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::XRay::Group](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.xray/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | -| **[AWS::XRay::ResourcePolicy](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.xray/default/types.md)** | | -| **[AWS::XRay::SamplingRule](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.xray/default/types.md)** | ⚠ This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | diff --git a/docs/content/reference/resource-schema/azure/index.md b/docs/content/reference/resource-schema/azure/index.md deleted file mode 100644 index 4c40c860a..000000000 --- a/docs/content/reference/resource-schema/azure/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -type: docs -title: "Supported Azure resources" -linkTitle: "Supported Azure resources " -manualLink: "https://learn.microsoft.com/azure/templates/" -manualLinkTarget: _blank -categories: "Schema" ---- diff --git a/docs/content/reference/resource-schema/cache/_index.md b/docs/content/reference/resource-schema/cache/_index.md deleted file mode 100644 index 245b6c236..000000000 --- a/docs/content/reference/resource-schema/cache/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Cache links" -linkTitle: "Cache" -description: "Learn what cache links are available in your application" -weight: 400 ---- diff --git a/docs/content/reference/resource-schema/cache/redis/index.md b/docs/content/reference/resource-schema/cache/redis/index.md deleted file mode 100644 index 1fa90076c..000000000 --- a/docs/content/reference/resource-schema/cache/redis/index.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -type: docs -title: "Redis cache" -linkTitle: "Redis" -description: "Learn how to use a Redis cache in your application" -categories: "Schema" ---- - -## Overview - -The `redislabs.com/Redis` is a [resource]({{< ref portable-resources >}}) which can be deployed to any platform Radius supports. - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/redis-recipe.bicep" embed=true marker="//REDIS" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/redis-manual.bicep" embed=true marker="//REDIS" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. | `cache` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| application | n | The ID of the application resource this resource belongs to. | `app.id` -| environment | y | The ID of the environment resource this resource belongs to. | `env.id` -| host | n | The Redis host name. | `redis.hello.com` -| port | n | The Redis port value. | `6379` -| [resourceProvisioning](#resource-provisioning) | n | Specifies how the underlying service/resource is provisioned and managed. Options are to provision automatically via 'recipe' or provision manually via 'manual'. Selection determines which set of fields to additionally require. Defaults to 'recipe'. | `manual` -| [recipe](#recipe) | n | Configuration for the Recipe which will deploy the backing infrastructure. | [See below](#recipe) -| [resources](#resources) | n | An array of IDs of the underlying resources. | [See below](#resources) -| username | n | The username for Redis cache. | `myusername` -| [secrets](#secrets) | n | Secrets used when building the resource from values. | [See below](#secrets) -| tls | n | Indicates if the Redis cache is configured with SSL connections. If the `port` value is set to 6380 this defaults to `true`. Otherwise it is defaulted to false. If your Redis cache offers SSL connections on ports other than 6380, explicitly set this value to `true` to override the default behavior. | `true` - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| \ | y | The name of the Recipe. Must be unique within the resource-type. | `myrecipe` -| parameters | n | A list of parameters to set on the Recipe for every Recipe usage and deployment. Can be overridden by the resource calling the Recipe. | `capacity: 1` - -#### Resources - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| id | n | Resource ID of the supporting resource. |`redisCache.id` - -#### Secrets - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| connectionString | n | The connection string for the Redis cache. Write only. | `contoso5.redis.cache.windows.net,ssl=true,password=...` -| password | n | The password for the Redis cache. Write only. | `mypassword` -| url | n | The connection URL for the Redis cache. Set automatically based on the values provided for `host`, `port`, `username`, and `password`. Can be explicitly set to override default behavior. Write only. | `redis://username:password@localhost:6380/0?ssl=true` | - -### Methods - -The following methods are available on the Redis cache: - -| Method | Description | Example | -|--------|-------------|---------| -| listSecrets() | Get the [secrets](#secrets) for the Redis cache. | `listSecrets().connectionString` | - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. -When no Recipe configuration is set, Radius will use the currently registered Recipe as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set to override this default. - -### Provision manually - -If you want to manually manage your infrastructure provisioning without the use of Recipes, you can set `resourceProvisioning` to `'manual'` and provide all necessary parameters and values that enable Radius to deploy or connect to the desired infrastructure. - -## Environment variables for connections - -Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Redis resource via connections. When a connection to Redis named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Redis resource: - -| Environment variable | Example(s) | -|----------------------|------------| -| CONNECTION_MYCONNECTION_HOST | `mycache.redis.cache.windows.net` | -| CONNECTION_MYCONNECTION_PORT | `6379` | -| CONNECTION_MYCONNECTION_TLS | `true` | -| CONNECTION_MYCONNECTION_USERNAME | `admin` | -| CONNECTION_MYCONNECTION_CONNECTIONSTRING | `contoso5.redis.cache.windows.net,ssl=true,password=...` | -| CONNECTION_MYCONNECTION_PASSWORD | `mypassword` | -| CONNECTION_MYCONNECTION_URL | `rediss://username:password@localhost:6380/0` | 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 deleted file mode 100644 index 19b0e0c9f..000000000 --- a/docs/content/reference/resource-schema/cache/redis/snippets/redis-manual.bicep +++ /dev/null @@ -1,35 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -resource azureRedis 'Microsoft.Cache/redis@2022-06-01' existing = { - name: 'mycache' -} - -//REDIS -resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview' = { - name: 'redis' - properties: { - environment: environment - application:app.id - resourceProvisioning: 'manual' - resources: [{ - id: azureRedis.id - }] - username: 'myusername' - host: azureRedis.properties.hostName - port: azureRedis.properties.port - secrets: { - password: azureRedis.listKeys().primaryKey - } - } -} -//REDIS 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 deleted file mode 100644 index e335f3840..000000000 --- a/docs/content/reference/resource-schema/cache/redis/snippets/redis-recipe.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//REDIS -resource redis 'Applications.Datastores/redisCaches@2023-10-01-preview' = { - name: 'redis' - properties: { - environment: environment - application:app.id - recipe: { - // Name a specific Recipe to use - name: 'azure-redis' - // Set optional/required parameters (specific to the Recipe) - parameters: { - size: 'large' - } - } - } -} -//REDIS diff --git a/docs/content/reference/resource-schema/core-schema/_index.md b/docs/content/reference/resource-schema/core-schema/_index.md deleted file mode 100644 index e13d22b42..000000000 --- a/docs/content/reference/resource-schema/core-schema/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Core resource schemas" -linkTitle: "Core" -description: "Reference the schemas of the core Radius resources" -weight: 200 ---- \ No newline at end of file diff --git a/docs/content/reference/resource-schema/core-schema/application-schema/index.md b/docs/content/reference/resource-schema/core-schema/application-schema/index.md deleted file mode 100644 index 9571361a1..000000000 --- a/docs/content/reference/resource-schema/core-schema/application-schema/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -type: docs -title: "Application reference" -linkTitle: "Application" -description: "Learn how to define an application" -weight: 200 ---- - -## Resource format - -{{< rad file="snippets/app.bicep" embed=true marker="//APP" >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `frontend` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| environment | y | The ID of the environment resource this container belongs to. | `env.id` -| [extensions](#extensions) | n | List of extensions on the container. | [See below](#extensions) - -#### Extensions - -Extensions allow you to customize how resources are generated or customized as part of deployment. - -##### kubernetesNamespace - -The Kubernetes namespace extension allows you to customize how all of the resources within your application generate Kubernetes resources. See the [Kubernetes mapping guide]({{< ref "/guides/operations/kubernetes/overview#resource-mapping" >}}) for more information on namespace mapping behavior. - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | The kind of extension being used. Must be 'kubernetesNamespace' | `kubernetesNamespace` | -| namespace | y | The namespace where all application-scoped resources generate Kubernetes objects. | `default` | - -##### kubernetesMetadata - -The [Kubernetes Metadata extension]({{< ref "guides/operations/kubernetes/kubernetes-metadata">}}) enables you set and cascade Kubernetes metadata such as labels and Annotations on all the Kubernetes resources defined with in your Radius Application. For examples, please refer to the extension overview page. - -###### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | The kind of extension being used. Must be 'kubernetesMetadata' | `kubernetesMetadata` | -| [labels](#labels)| n | The Kubernetes labels to be set on the application and its resources | [See below](#labels)| -| [annotations](#annotations) | n | The Kubernetes annotations to set on your application and its resources | [See below](#annotations)| - -###### labels - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| user defined label key | y | The key and value of the label to be set on the application and its resources.|`'team.name': 'frontend'` - -###### annotations - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| user defined annotation key | y | The key and value of the annotation to be set on the application and its resources.| `'app.io/port': '8081'` | 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 deleted file mode 100644 index f84259f50..000000000 --- a/docs/content/reference/resource-schema/core-schema/application-schema/snippets/app.bicep +++ /dev/null @@ -1,24 +0,0 @@ -extension radius - -param environment string - -//APP -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - extensions: [ - { - kind: 'kubernetesNamespace' - namespace: 'myapp' - } - { - kind: 'kubernetesMetadata' - labels: { - 'team.contact.name': 'frontend' - } - } - ] - } -} -//APP diff --git a/docs/content/reference/resource-schema/core-schema/container-schema/index.md b/docs/content/reference/resource-schema/core-schema/container-schema/index.md deleted file mode 100644 index 10ad264f2..000000000 --- a/docs/content/reference/resource-schema/core-schema/container-schema/index.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -type: docs -title: "Container service" -linkTitle: "Container" -description: "Learn how to add a container to your Radius Application" -weight: 300 ---- - -`Container` provides an abstraction for a container workload that can be run on any platform Radius supports. - -## Resource format - -{{< rad file="snippets/container.bicep" embed=true marker="//CONTAINER" >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `frontend` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| application | y | The ID of the application resource this container belongs to. | `app.id` -| [container](#container) | y | Container configuration. | [See below](#container) -| [connections](#connections) | n | List of connections to other resources. | [See below](#connections) -| [extensions](#extensions) | n | List of extensions on the container. | [See below](#extensions) -| [runtimes](#runtimes) | n | Runtime specific configurations for the container. | [See below](#runtimes) - -### Container - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| image | y | The registry and image to download and run in your container. Follows the format `:/:` where registry hostname is optional and defaults to the Docker public registry, port is optional and defaults to 443, tag is optional and defaults to `latest`.| `ghcr.io/USERNAME/myimage:latest` -| env | n | A list of environment variables to be set for the container. Environment variables can either be of `value` or a reference to a Application.Core/SecretStore resource id in the format `valueFrom`. | `'ENV_VAR': { value: 'value' }` or `'ENV_VAR': { valueFrom: { secretRef: { source: secret.id key: 'SECRET_KEY' } } }` -| command | n | Entrypoint array. Overrides the container image's ENTRYPOINT. | `['/bin/sh']` -| args | n | Arguments to the entrypoint. Overrides the container image's CMD. | `['-c', 'while true; do echo hello; sleep 10;done']` -| imagePullPolicy | n | How to pull images. Defaults to the runtime's default behavior. For Kubernetes behavior refer to https://kubernetes.io/docs/concepts/containers/images/#required-image-pull | `'Always'` -| workingDir | n | Working directory for the container. | `'/app'` -| [ports](#ports) | n | Ports the container provides | [See below](#ports). -| [readinessProbe](#readiness-probe) | n | Readiness probe configuration. | [See below](#readiness-probe). -| [livenessProbe](#liveness-probe) | n | Liveness probe configuration. | [See below](#liveness-probe). -| [volumes](#volumes) | n | Volumes to mount into the container. | [See below](#volumes). - -#### Ports - -The ports offered by the container are defined in the `ports` section. - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | A name key for the port. | `http` -| containerPort | y | The port the container exposes. | `80` -| protocol | n | The protocol the container exposes. Options are 'TCP' and 'UCP'. | `'TCP'` - -#### Volumes - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | A name key for the volume. | `tempstore` -| kind | y | The type of volume, either `ephemeral` or `persistent`. | `ephemeral` -| mountPath | y | The container path to mount the volume to. | `\tmp\mystore` -| managedStore | y* | The backing storage medium to use when kind is 'ephemeral'. Either `disk` or `memory`. | `memory` -| source | y* | A volume resource to mount when kind is 'persistent'. | `myvolume.id` -| rbac | n | The role-based access control level when kind is 'persistent'. Allowed values are `'read'` and `'write'`. Defaults to 'read'. | `'read'` - -#### Readiness probe - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | Type of readiness check, `httpGet` or `tcp` or `exec`. | `httpGet` -| containerPort | n | Used when kind is `httpGet` or `tcp`. The listening port number. | `8080` -| path | n | Used when kind is `httpGet`. The route to make the HTTP request on | `'/healthz'` -| command | n | Used when kind is `exec`. Command to execute to probe readiness | `'/healthz'` -| initialDelaySeconds | n | Initial delay in seconds before probing for readiness. | `10` -| failureThreshold | n | Threshold number of times the probe fails after which a failure would be reported. | `5` -| periodSeconds | n | Interval for the readiness probe in seconds. | `5` - -#### Liveness probe - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | Type of liveness check, `httpGet` or `tcp` or `exec`. | `httpGet` -| containerPort | n | Used when kind is `httpGet` or `tcp`. The listening port number. | `8080` -| path | n | Used when kind is `httpGet`. The route to make the HTTP request on | `'/healthz'` -| command | n | Used when kind is `exec`. Command to execute to probe liveness | `'/healthz'` -| initialDelaySeconds | n | Initial delay in seconds before probing for liveness. | `10` -| failureThreshold | n | Threshold number of times the probe fails after which a failure would be reported. | `5` -| periodSeconds | n | Interval for the liveness probe in seconds. | `5` - -### Connections - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | A name key for the port. | `inventory` -| source | y | The id of the resource the container is connecting to. For network connections to other services this is in the form `'[scheme]://[serviceName]:[port]'` | `db.id`, `'http://inventory:8080'` -| [iam](#iam) | n | Identity and access management (IAM) roles to set on the target resource. | [See below](#iam) - -#### IAM - -Identity and access management (IAM) roles to set on the target resource. - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | Type of IAM role. Only `azure` supported today | `'azure'` -| roles | y | The list IAM roles to set on the target resource. | `'Owner'` - -### Extensions - -Extensions define additional capabilities and configuration for a container. - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | The kind of extension being used. | `kubernetesMetadataextension` - -Additional properties are available and required depending on the 'kind' of the extension. - -#### kubernetesMetadata - -The [Kubernetes Metadata extension]({{< ref "guides/operations/kubernetes/kubernetes-metadata">}}) enables you set and cascade Kubernetes metadata such as labels and Annotations on all the Kubernetes resources defined with in your Radius Application. For examples refer to the extension overview page. - -##### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | The kind of extension being used. Must be 'kubernetesMetadata' | `kubernetesMetadata` | -| [labels](#labels)| n | The Kubernetes labels to be set on the application and its resources | [See below](#labels)| -| [annotations](#annotations) | n | The Kubernetes annotations to set on your application and its resources | [See below](#annotations)| - -###### labels - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| user defined label key | y | The key and value of the label to be set on the application and its resources.|`'team.name': 'frontend'` - -###### annotations - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| user defined annotation key | y | The key and value of the annotation to be set on the application and its resources.| `'app.io/port': '8081'` | - -#### daprSidecar - -The `daprSidecar` extensions adds and configures a [Dapr](https://dapr.io) sidecar to your application. - -##### Properties - -| Property | Required | Description | Example | -|----------|:--------:|-------------|---------| -| kind | y | The kind of extension. | `daprSidecar` -| appId | n | The appId of the Dapr sidecar. | `backend` | -| appPort | n | The port your service exposes to Dapr | `3500` -| config | n | The configuration to use for the Dapr sidecar | - -#### manualScaling - -The `manualScaling` extension configures the number of replicas of a compute instance (such as a container) to run. - -##### Properties - -| Property | Required | Description | Example | -|----------|:--------:|-------------|---------| -| kind | y | The kind of extension. | `manualScaling` -| replicas | Y | The number of replicas to run | `5` | - -### Runtimes - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kubernetes | n | Kubernetes specific configuration for the container. | [See below](#kubernetes) -| aci | n | Azure Container Instances specific configuration for the container. | [See below](#aci) - -#### Kubernetes - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| base | n | The base Kubernetes resource manifest on top of which Radius specified properties will be applied. Supported resource types are documented [here]({{}}). | `loadTextContent('manifest/base-container.yaml')` -| pod | n | The pod specifications to apply to the Kubernetes resource created by Radius. Any field defined on [PodSpec](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec) can be set here. | [`topologySpreadConstraints`](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) - -#### ACI - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| gatewayID | n | The gateway resource ID that provides L7 traffic for the container. | `'myGatewayId'` diff --git a/docs/content/reference/resource-schema/core-schema/container-schema/snippets/base-container.yaml b/docs/content/reference/resource-schema/core-schema/container-schema/snippets/base-container.yaml deleted file mode 100644 index a0c37ba77..000000000 --- a/docs/content/reference/resource-schema/core-schema/container-schema/snippets/base-container.yaml +++ /dev/null @@ -1,19 +0,0 @@ -apiVersion: apps/v1 -kind: Deployment -metadata: - name: frontend - labels: - app: frontend -spec: - replicas: 1 - selector: - matchLabels: - app: frontend - template: - metadata: - labels: - app: frontend - spec: - containers: - - name: frontend - image: ghcr.io/radius-project/magpiego:latest \ No newline at end of file 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 deleted file mode 100644 index 3542433f4..000000000 --- a/docs/content/reference/resource-schema/core-schema/container-schema/snippets/container.bicep +++ /dev/null @@ -1,125 +0,0 @@ -extension radius - -param environment string - -param azureStorage string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -resource volume 'Applications.Core/volumes@2023-10-01-preview' existing = { - name: 'myvolume' -} - -//CONTAINER -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: app.id - container: { - image: 'registry/container:tag' - env:{ - DEPLOYMENT_ENV: { - value: 'prod' - } - DB_CONNECTION: { - value: db.listSecrets().connectionString - } - } - ports: { - http: { - containerPort: 80 - protocol: 'TCP' - } - } - volumes: { - ephemeralVolume: { - kind: 'ephemeral' - mountPath: '/tmpfs' - managedStore: 'memory' - } - persistentVolume: { - kind: 'persistent' - source: volume.id - } - } - readinessProbe:{ - kind:'httpGet' - containerPort:8080 - path: '/healthz' - initialDelaySeconds:3 - failureThreshold:4 - periodSeconds:20 - } - livenessProbe:{ - kind:'exec' - command:'ls /tmp' - } - command: [ - '/bin/sh' - ] - args: [ - '-c' - 'while true; do echo hello; sleep 10;done' - ] - workingDir: '/app' - } - connections: { - inventory: { - source: db.id - } - azureStorage: { - source: azureStorage - iam: { - kind: 'azure' - roles: [ - 'Storage Blob Data Contributor' - ] - } - } - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'frontend' - } - { - kind: 'manualScaling' - replicas: 5 - } - { - kind: 'kubernetesMetadata' - labels: { - 'team.contact.name': 'frontend' - } - } - ] - runtimes: { - kubernetes: { - base: loadTextContent('base-container.yaml') - pod: { - containers: [ - { - name: 'log-collector' - image: 'ghcr.io/radius-project/fluent-bit:2.1.8' - } - ] - hostNetwork: true - } - } - } - } -} -//CONTAINER - -resource db 'Applications.Datastores/mongoDatabases@2023-10-01-preview' = { - name: 'database' - properties: { - environment: environment - application: app.id - } -} diff --git a/docs/content/reference/resource-schema/core-schema/environment-schema/index.md b/docs/content/reference/resource-schema/core-schema/environment-schema/index.md deleted file mode 100644 index 90dae76e9..000000000 --- a/docs/content/reference/resource-schema/core-schema/environment-schema/index.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -type: docs -title: "Environment" -linkTitle: "Environment" -description: "Learn how to define an environment" -weight: 100 ---- - -## Resource format - -{{< rad file="snippets/environment.bicep" embed=true marker="//ENV" >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `frontend` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| [compute](#compute) | y | Container runtime configuration. | [See below](#compute) -| [recipeConfig](#recipeconfig) | n | Configuration for Recipes. Defines how each type of Recipe should be configured and run. | [See below](#recipeconfig) -| [recipes](#recipes) | n | Recipes registered to the environment. | [See below](#recipes) -| simulated | n | When enabled, a simulated environment will not deploy any output resources or run any Recipes when an application is deployed. This is useful for dry runs or testing. Defaults to `false`. | `true` -| [extensions](#extensions) | n | The environment extension. | [See below](#extensions) -| [providers](#providers) | n | The cloud provider configuration, either `azure` or `aws`. | [See below](#providers) - -### compute - -Details on what to run and how to run it are defined in the `container` property: - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | The kind of container runtime to use, with `'kubernetes'` and `'aci'` currently supported. | `'kubernetes'` -| namespace | n | The Kubernetes namespace to render application resources into, only required for Kubernetes environments. | `'default'` -| resourceId | n | The resource ID of the AKS cluster to render application resources into, only required for Azure environments. | `aksCluster.id` -| resourceGroup | n | The resource group to render application resources into, only required for ACI environments. | `'/subscriptions/mySubscriptionId/resourceGroups/my-resource-group'` -| identity | n | The cluster identity configuration. | [See below](#identity) | - -### identity - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | The kind of identity, `'azure.com.workload'`, `'userAssigned'`, `'systemAssigned'`, and `'systemAssignedUserAssigned'` are currently supported; if not provided and `compute.kind` is set to `'aci'` then defaults to `'systemAssigned'` | `'systemAssigned'` | -| oidcIssuer | n | The [OIDC issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for your Kubernetes cluster | `'{IssuerURL}/.well-known/openid-configuration'` | -| managedIdentity | n | The list of assigned managed identities, this is only required if the kind is set to `'userAssigned'` or `'systemAssignedUserAssigned'` | [`'/subscriptions/mySubscriptionId/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myManagedIdentity'`] - -### recipeConfig - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| terraform | y | Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment. | [See below](#terraform-properties) -| env | n | Environment variables injected during Terraform Recipe execution for the recipes in the environment. | [See below](#env-properties) - -#### terraform properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| authentication | y | Authentication information used to access private Terraform module sources. Supported module sources: Git. | [See below](#authentication-properties) -| providers | n | Configuration for Terraform Recipe Providers. Controls how Terraform interacts with cloud providers, SaaS providers, and other APIs. | For more information refer to the [Terraform documentation](https://developer.hashicorp.com/terraform/language/providers/configuration). - -##### authentication properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| pat | y | Personal Access Token (PAT) configuration used to authenticate to Git platforms. | [See below](#pat-properties) - -##### pat properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| secret | y | The ID of an Applications.Core/SecretStore resource containing the Git platform personal access token (PAT). The secret store must have a secret named 'pat', containing the PAT value. A secret named 'username' is optional, containing the username associated with the pat. By default no username is specified. | For more information refer to the [Terraform documentation](https://developer.hashicorp.com/terraform/language/providers/configuration). - -#### env properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| \ | n | User-defined environment variables. | `'env_var_1'`: `'env_value_1'` - -### recipes - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| \ | y | The type of resource to register Recipes for. | `'Applications.Datastores/redisCaches'` -| recipes | y | The list of Recipes registered to a given resource type | [See below](#recipe-properties) - -#### recipe properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| \ | y | The name of the Recipe. Must be unique within the resource-type. | `myrecipe` -| templateKind | y | Format of the template provided by the recipe. Allowed values: bicep | `'bicep'` -| templatePath | y | The path to the Recipe contents. For Bicep Recipes this is a Bicep module registry address. | `'ghcr.io/USERNAME/recipes/myrecipe:1.0'` -| parameters | n | A list of parameters to set on the Recipe for every Recipe usage and deployment. Can be overridden by the resource calling the Recipe. | `capacity: 1` - -### extensions - -Extensions allow you to customize how resources are generated or customized as part of deployment. - -#### kubernetesMetadata - -The [Kubernetes Metadata extension]({{< ref "guides/operations/kubernetes/kubernetes-metadata">}}) enables you set and cascade Kubernetes metadata such as labels and Annotations on all the Kubernetes resources defined with in your Radius Application. For examples, please refer to the extension overview page. - -##### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| kind | y | The kind of extension being used. Must be 'kubernetesMetadata' | `kubernetesMetadata` | -| [labels](#labels) | n | The Kubernetes labels to be set on the application and its resources | [See below](#labels)| -| [annotations](#annotations) | n | The Kubernetes annotations to set on your application and its resources | [See below](#annotations)| - -##### labels - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| user defined label key | y | The key and value of the label to be set on the application and its resources.|`'team.name': 'frontend'` - -##### annotations - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| user defined annotation key | y | The key and value of the annotation to be set on the application and its resources.| `'app.io/port': '8081'` | - -### providers -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| scope | n | The target level for deploying the cloud resources. | `'/subscriptions/mySubscriptionId/resourceGroups/my-resource-group'`| - -## Further reading - -- [Radius Environments]({{< ref "concepts/environments" >}}) 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 deleted file mode 100644 index 1b05facc4..000000000 --- a/docs/content/reference/resource-schema/core-schema/environment-schema/snippets/environment.bicep +++ /dev/null @@ -1,32 +0,0 @@ -extension radius - -param oidcIssuer string - -//ENV -resource environment 'Applications.Core/environments@2023-10-01-preview' = { - name: 'myenv' - properties: { - compute: { - kind: 'kubernetes' // Required. The kind of container runtime to use - namespace: 'default' // Required. The Kubernetes namespace in which to render application resources - identity: { // Optional. External identity providers to use for connections - kind: 'azure.com.workload' - oidcIssuer: oidcIssuer - } - } - providers: { - azure: { - scope: '/subscriptions/mySubscriptionId/resourceGroups/my-resource-group' - } - } - extensions: [ - { - kind: 'kubernetesMetadata' - labels: { - 'team.contact.name': 'frontend' - } - } - ] - } -} -//ENV diff --git a/docs/content/reference/resource-schema/core-schema/extender/index.md b/docs/content/reference/resource-schema/core-schema/extender/index.md deleted file mode 100644 index b5af43c6a..000000000 --- a/docs/content/reference/resource-schema/core-schema/extender/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -type: docs -title: "Extender resource" -linkTitle: "Extender" -description: "Learn how to use Extender resource in Radius" -weight: 999 -slug: "extender" ---- - -## Overview - -An extender resource could be used to bring in a custom resource into Radius for which there is no first class support to "extend" the Radius functionality. The resource can define arbitrary key-value pairs and secrets. These properties and secret values can then be used to connect it to other Radius resources. - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/extender-recipe.bicep" embed=true marker="//EXTENDER" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/extender-manual.bicep" embed=true marker="//EXTENDER" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. | `mongo` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| \ | n | User-defined properties of the extender. Can accept any key name except 'secrets'. | `fromNumber: '222-222-2222'` -| secrets | n | Secrets in the form of key-value pairs | `password: '******'` -| resourceProvisioning | n | Specifies how to build the resource. Options are to build automatically via 'recipe' or build manually via 'manual'. Selection determines which set of fields to additionally require. | `manual` -| [recipe](#recipe) | n | The recipe to deploy. | [See below](#recipe) - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| name | n | Specifies the name of the Recipe that should be deployed. If not set, the name defaults to `default`. | `name: 'twilio'` -| parameters | n | An object that contains a list of parameters to set on the Recipe. | `{ fromNumber: '222-222-2222' }` - -## Methods - -The following methods are available on the Extender resource: - -| Method | Description | -|--------|-------------| -| .listSecrets('SECRET_NAME') | Get the value of a secret. | - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref "concepts/recipes" >}}) automate infrastructure provisioning using approved templates. -You can specify a Recipe name that is registered in the environment or omit the name and use the "default" Recipe. - -Parameters can also optionally be specified for the Recipe. - -### Provision manually - -If you want to manually manage your infrastructure provisioning outside of Recipes, you can set `resourceProvisioning` to `'manual'` and provide all necessary parameters and values in order for Radius to be able to deploy/connect to the desired infrastructure. \ No newline at end of file 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 deleted file mode 100644 index 629cafb35..000000000 --- a/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-manual.bicep +++ /dev/null @@ -1,47 +0,0 @@ -extension radius - -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//EXTENDER -resource twilio 'Applications.Core/extenders@2023-10-01-preview' = { - name: 'twilio' - properties: { - application: app.id - environment: environment - resourceProvisioning: 'manual' - fromNumber: '222-222-2222' - secrets: { - accountSid: 'sid' - authToken: 'token' - } - } -} -//EXTENDER - -resource publisher 'Applications.Core/containers@2023-10-01-preview' = { - name: 'publisher' - properties: { - application: app.id - container: { - image: 'ghcr.io/radius-project/magpiego:latest' - env: { - TWILIO_NUMBER: { - value: twilio.properties.fromNumber - } - TWILIO_SID: { - value: twilio.listSecrets().accountSid - } - TWILIO_ACCOUNT: { - value: 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 deleted file mode 100644 index 0af42826a..000000000 --- a/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep +++ /dev/null @@ -1,38 +0,0 @@ -extension radius - -param application string -param environment string - -// EXTENDER -resource twilio 'Applications.Core/extenders@2023-10-01-preview' = { - name: 'twilio' - properties: { - application: application - environment: environment - recipe: { - name: 'twilio' - } - } -} -//EXTENDER - -resource publisher 'Applications.Core/containers@2023-10-01-preview' = { - name: 'publisher' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/magpiego:latest' - env: { - TWILIO_NUMBER: { - value: twilio.properties.fromNumber - } - TWILIO_SID: { - value: twilio.listSecrets().accountSid - } - TWILIO_ACCOUNT: { - value: twilio.listSecrets().authToken - } - } - } - } -} diff --git a/docs/content/reference/resource-schema/core-schema/gateway/index.md b/docs/content/reference/resource-schema/core-schema/gateway/index.md deleted file mode 100644 index 3974b8048..000000000 --- a/docs/content/reference/resource-schema/core-schema/gateway/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -type: docs -title: "Gateway" -linkTitle: "Gateway" -description: "Learn how to route requests to different resources" -weight: 401 ---- - -## Resource format - -{{< rad file="snippets/gateway.bicep" embed=true marker="//GATEWAY" >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your Gateway. | `'gateway'` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| application | y | The ID of the application resource this resource belongs to. | `app.id` -| [hostname](#hostname) | n | The hostname information for this gateway. | [See below](#hostname) -| [routes](#routes) | y | The routes attached to this gateway. | [See below](#routes) -| [tls](#tls) | n | TLS/SSL configuration for this gateway. | [See below](#tls) - -#### Routes - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| path | y* | The path to match the incoming request path on. Not required when `tls.sslPassthrough` is set to `'true'`. | `'/service'` -| destination | y | The service to route traffic to, in the form `'[scheme]://[serviceName]:[port]'` | `'http://backend:80'` -| replacePrefix | n | The prefix to replace in the incoming request path that is sent to the destination route. | `'/'` -| enableWebsockets | n | Enables websocket support for the route. Defaults to false. | `true` -| timeoutPolicy | n | The timeout policy for the route. | See [below](#timeout-policy) - -##### Timeout Policy -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| request | n | The timeout for the request in seconds. Defaults to 15 seconds. | `30s` -| backendRequest | n | The timeout for the backend request in seconds. Defaults to 15 seconds. | `30s` - -#### Hostname - -You can define hostname information for how to access your application. See [below](#hostname-generation) for more information. - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| prefix | n | A custom DNS prefix for the generated hostname. | `'prefix'` -| fullyQualifiedHostname | n | A fully-qualified domain name to use for the gateway. | `'myapp.mydomain.com'` - -#### TLS - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| sslPassthrough | n | Configures the gateway to passthrough encrypted SSL traffic to an HTTP route and container. Requires a single route to be set with no 'path' defined (just destination). With sslPassthrough set to `true`, the gateway can only support SNI routing. Path based routing cannot be supported. Defaults to 'false'. | `true` -| hostname | n | The hostname for TLS termination. | `'hostname.radapp.io'` -| certificateFrom | n | The Radius Secret Store resource ID that holds the TLS certificate data for TLS termination. | `secretstore.id` -| minimumProtocolVersion | n | The minimum TLS protocol to support for TLS termination. | `'1.2'` - -Note that SSL passthrough and TLS termination functionality are mutually exclusive. - -## Hostname Generation - -There are three options for defining hostnames: - -1. Omit the `hostname` property, and Radius will generate the hostname for you with the format: `gatewayname.appname.PUBLIC_HOSTNAME_OR_IP.nip.io`. -1. Declare `hostname.prefix`, and Radius will generate the hostname based on your chosen prefix: `prefix.appname.PUBLIC_HOSTNAME_OR_IP.nip.io`. -1. Declare `hostname.fullyQualifiedHostname`, and Radius will use your fully-qualified domain name as the hostname: `myapp.mydomain.com`. Note that you must map the public IP of the platform your app is running on to the chosen hostname. If you provide this property as well as `prefix`, this property will take precedence. 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 deleted file mode 100644 index b6776f703..000000000 --- a/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep +++ /dev/null @@ -1,97 +0,0 @@ -extension radius - -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//GATEWAY -resource gateway 'Applications.Core/gateways@2023-10-01-preview' = { - name: 'gateway' - properties: { - application: app.id - hostname: { - // Omitting hostname properties results in gatewayname.appname.PUBLIC_HOSTNAME_OR_IP.nip.io - - // Results in prefix.appname.PUBLIC_HOSTNAME_OR_IP.nip.io - prefix: 'prefix' - // Alternately you can specify your own hostname that you've configured externally - fullyQualifiedHostname: 'hostname.radapp.io' - } - routes: [ - { - path: '/frontend' - destination: 'http://${frontend.name}:3000' - } - { - path: '/backend' - destination: 'http://${backend.name}:8080' - - // Enable websocket support for the route (default: false) - enableWebsockets: true - } - ] - tls: { - // Specify SSL Passthrough for your app (default: false) - sslPassthrough: false - - // The Radius Secret Store holding TLS certificate data - certificateFrom: secretstore.id - // The minimum TLS protocol version to support. Defaults to 1.2 - minimumProtocolVersion: '1.2' - } - } -} -//GATEWAY - -resource secretstore 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'secretstore' - properties: { - application: app.id - data: { - } - } -} - -//FRONTEND -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: app.id - container: { - image: 'registry/container:tag' - ports: { - http: { - containerPort: 3000 - } - } - } - connections: { - backend: { - source: 'http://backend:8080' - } - } - } -} -//FRONTEND - -//BACKEND -resource backend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'backend' - properties: { - application: app.id - container: { - image: 'registry/container:tag' - ports: { - http: { - containerPort: 8080 - } - } - } - } -} -//BACKEND diff --git a/docs/content/reference/resource-schema/core-schema/secretstore/index.md b/docs/content/reference/resource-schema/core-schema/secretstore/index.md deleted file mode 100644 index a946741c8..000000000 --- a/docs/content/reference/resource-schema/core-schema/secretstore/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -type: docs -title: "Radius Secret Store" -linkTitle: "Secret Store" -description: "Learn how to define a secret store" ---- - -Note that only Kubernetes Secrets are currently supported with more to come in the future. - -## Resource format - -### Creating a new Secret Store - -{{< rad file="snippets/secretstore.bicep" embed=true marker="//SECRET_STORE_NEW" >}} - -### Referencing an existing Secret Store - -{{< rad file="snippets/secretstore.bicep" embed=true marker="//SECRET_STORE_REF" >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your Secret Store. | `'secret'` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -#### properties - -| Key | Required | Description | Example | -|----------|:--------:|-------------|---------| -| application | n | The ID of the application resource this resource belongs to. | `app.id` | -| resource | n | Reference to the backing secret store resource, required only if valueFrom specifies referenced secret name. | `namespace/secretName` | -| type | y | The type of secret in your resource. | `'certificate'` -| [data](#data) | y | An object to represent key-value type secrets. | [See below](#data) - -##### data - -This property is an object to represent key-value type secrets. You define your own key for each secret (e.g. `'tls.key'`), with the `encoding`, `value`, and `valueFrom` properties representing each secret value: - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| value | y | The value of the secret key. | `'secretString'` -| encoding | n | The encoding type of the data value (default is `'raw'`). | `'base64'` -| [valueFrom](#valuefrom) | n | A reference to an external secret. This field is currently not in use, as it is meant for supporting more types of external secrets in the future. | [See below](#valuefrom) - -###### valueFrom - -*Note:* `valueFrom` is not supported for Kubernetes Secrets, but may be used for other secret store types in the future. - -| Key | Required | Description | Example | -|------------|:--------:|-------------|---------| -| name | y | The name of the secret or key of `properties.resource`. | `'secret_key1_name'` -| version | n | The version of the secret. | `1` \ No newline at end of file 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 deleted file mode 100644 index d9a9511ad..000000000 --- a/docs/content/reference/resource-schema/core-schema/secretstore/snippets/secretstore.bicep +++ /dev/null @@ -1,61 +0,0 @@ -extension radius - -@description('Specifies the location for resources.') -param location string = 'global' - -@description('Specifies the environment for resources.') -param environment string - -@description('Specifies tls cert secret values.') -@secure() -param tlscrt string -@secure() -param tlskey string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'corerp-resources-secretstore' - location: location - properties: { - environment: environment - extensions: [ - { - kind: 'kubernetesNamespace' - namespace: 'corerp-resources-secretstore-app' - } - ] - } -} - -//SECRET_STORE_NEW -resource appCert 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'appcert' - properties:{ - application: app.id - type: 'certificate' - data: { - 'tls.key': { - value: tlskey - } - 'tls.crt': { - value: tlscrt - } - } - } -} -//SECRET_STORE_NEW - -//SECRET_STORE_REF -resource existingAppCert 'Applications.Core/secretStores@2023-10-01-preview' = { - name: 'existing-appcert' - properties:{ - application: app.id - resource: 'secret-app-existing-secret' // Reference to the name of an external secret store - type: 'certificate' // The type of secret in your resource - data: { - // The keys in this object are the names of the secrets in an external secret store - 'tls.crt': {} - 'tls.key': {} - } - } -} -//SECRET_STORE_REF diff --git a/docs/content/reference/resource-schema/core-schema/volumes/_index.md b/docs/content/reference/resource-schema/core-schema/volumes/_index.md deleted file mode 100644 index fec6ee37f..000000000 --- a/docs/content/reference/resource-schema/core-schema/volumes/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -type: docs -title: "Radius Volumes" -linkTitle: "Volumes" -description: "Learn about Radius volumes" ---- \ No newline at end of file diff --git a/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/index.md b/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/index.md deleted file mode 100644 index aa9b71fc3..000000000 --- a/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -type: docs -title: "Azure Key Vault volume" -linkTitle: "Azure Key Vault" -description: "Learn about Radius persistent Azure Key Vault volumes" -slug: "azure-keyvault" ---- - -Radius supports mounting an Azure Key Vault as a persistent volume to the container using the Azure KeyVault CSI Driver. - -## Prerequisites - -- [Azure Key Vault CSI Driver](https://azure.github.io/secrets-store-csi-driver-provider-azure/docs/demos/standard-walkthrough/) installed on your cluster -- [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/installation.html) installed on your cluster -- `azure.com.workload` identity configured on your [environment]({{< ref "concepts/environments" >}}) -- Your Azure Key Vault access policy should be set to [Azure role-based access control](https://learn.microsoft.com/azure/key-vault/general/rbac-guide?tabs=azure-cli) - -## Resource format - -{{< rad file="snippets/volume-keyvault.bicep" embed=true marker="//VOLUME" >}} - -### Properties - -The following properties are available on the `Volume` resource to which the container attaches: - -| Key | Required | Description | Example | -|------|:--------:|:------------|---------| -| kind | y | The kind of persistent volume. Should be 'azure.com.keyvault' for Azure Key Vault persistent volumes | `'azure.com.keyvault'` -| resource | n | Resource ID for the Azure KeyVault resource. | `'kv.id'`, `'/subscriptions//resourceGroups/'` -| secrets | n | Map specify secret object name and secret properties. See [secret properties](#secrets) | mysecret: {
name: 'mysecret'{
encoding: 'utf-8{
} -| keys | n | Map specify key object name and key properties. See [key properties](#keys) | mykey: {
name: 'mykey'
} -| certificates | n | Map specify certificate object name and [certificate properties]. See [certificate properties](#certificate) | mycert: {
name: 'mycert'
value: 'certificate'
} - -#### Secrets - -| Key | Description | Required | Example | -|------|:------------|----------|---------| -| name | secret name in Azure Key Vault | true | `'mysecret'` -| version | specific secret version. Default is latest | false | `'1234'` -| encoding | encoding format 'utf-8', 'hex', 'base64'. Default is 'utf-8' | false | `'bas64'` -| alias | file name created on the disk. Same as objectname if not specified | false | `'my-secret'` - -#### Keys - -| Key | Description | Required | Example | -|------|:------------|----------|---------| -| name | key name in Azure Key Vault | true | `'mykey'` -| version | specific key version. Default is latest | false | `'1234'` -| alias | file name created on the disk. Same as objectname if not specified | false | `'my-key'` - -#### Certificates - -| Key | Description | Required | Example | -|------|:------------|----------|---------| -| name | certificate name in Azure Key Vault | true | `'mycert'` -| value | value to download from Azure Key Vault 'privatekey', 'publickey' or 'certificate' | true | `'certificate'` -| version | specific certificate version. Default is latest | false | `'1234'` -| encoding | encoding format 'utf-8', 'hex', 'base64'. Default is 'utf-8' and this field can be specificed only when value is 'privatekey' | false | `'bas64'` -| alias | file name created on the disk. Same as objectname if not specified | false | `'my-cert'` -| format | certificate format 'pfx', 'pem'. Default is 'pfx' | false | `'my-cert'` 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 deleted file mode 100644 index fc3552f64..000000000 --- a/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/snippets/volume-keyvault.bicep +++ /dev/null @@ -1,63 +0,0 @@ -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 - -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -resource keyvault 'Microsoft.KeyVault/vaults@2022-07-01' = { - name: 'myvault' - location: azLocation - properties: { - sku: { - family: 'A' - name: 'standard' - } - tenantId: subscription().tenantId - enableRbacAuthorization: true - softDeleteRetentionInDays: 7 - } -} - -//VOLUME -resource volume 'Applications.Core/volumes@2023-10-01-preview' = { - name: 'myvolume' - properties: { - application: app.id - kind: 'azure.com.keyvault' - resource: keyvault.id - secrets: { - mysecret: { - name: 'secret1' // required - version: '1' // optional, defaults to latest version - alias: 'secretalias' // optional, defaults to secret name (mysecret) - encoding: 'utf-8' // optional, defaults to utf-8 - } - } - certificates: { - mycertificate: { - name: 'cert1' // required - 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 - certType: 'privatekey' // required - format: 'pem' // optional, defaults to pfx - } - } - keys: { - mykey: { - name: 'key1' // required - version: '1' // optional, defaults to latest version - alias: 'keyalias' // optional, defaults to key name (mycertificate) - } - } - } -} -//VOLUME diff --git a/docs/content/reference/resource-schema/dapr-schema/_index.md b/docs/content/reference/resource-schema/dapr-schema/_index.md deleted file mode 100644 index 48933a544..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -type: docs -title: "Dapr links" -linkTitle: "Dapr" -description: "Learn what Dapr resources are available in your application" -weight: 600 -slug: "dapr" ---- diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/index.md b/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/index.md deleted file mode 100644 index a37bef48f..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -type: docs -title: "Dapr Configuration Store resource" -linkTitle: "Configuration Store" -description: "Learn how to use Dapr Configuration Store in Radius" -weight: 300 -slug: "configurationStore" ---- - -## Overview - -An `Applications.Dapr/configurationStores` resource represents a [Dapr configuration](https://docs.dapr.io/operations/configuration/configuration-overview/) store. - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/dapr-configuration-recipe.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/dapr-configuration-manual.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of the configuration store. Names must contain at most 63 characters, contain only lowercase alphanumeric characters, '-', or '.', start with an alphanumeric character, and end with an alphanumeric character. | `my-config` | -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| application | n | The ID of the application resource this resource belongs to. | `app.id` -| environment | y | The ID of the environment resource this resource belongs to. | `env.id` -| [resourceProvisioning](#resource-provisioning) | n | Specifies how the underlying service/resource is provisioned and managed. Options are to provision automatically via 'recipe' or provision manually via 'manual'. Selection determines which set of fields to additionally require. Defaults to 'recipe'. | `manual` -| [recipe](#recipe) | n | Configuration for the Recipe which will deploy the backing infrastructure. | [See below](#recipe) -| [resources](#resources) | n | An array of resources which underlay this resource. For example, an Azure Redis Cache ID if the Dapr Configuration Store resource is leveraging Azure Redis Cache. | [See below](#resources) -| type | n | The Dapr component type. Set only when resourceProvisioning is 'manual'. | `configuration.redis` | -| metadata | n | Metadata object for the Dapr component. Schema must match [Dapr component](https://docs.dapr.io/reference/components-reference/supported-configuration-stores/). Set only when resourceProvisioning is 'manual'. | `{ redisHost: 'localhost:6379' }` | -| version | n | The version of the Dapr component. See [Dapr components](https://docs.dapr.io/reference/components-reference/supported-configuration-stores/) for available versions. Set only when resourceProvisioning is 'manual'. | `v1` | -| componentName | n | _(read-only)_ The name of the Dapr component that is generated and applied to the underlying system. Used by the Dapr SDKs or APIs to access the Dapr component. | `myconfig` | - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| name | n | Specifies the name of the Recipe that should be deployed. If not set, the name defaults to `default`. | `name: 'azure-prod'` -| parameters | n | An object that contains a list of parameters to set on the Recipe. | `{ size: 'large' }` - -#### Resources - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| id | n | Resource ID of the supporting resource. | `account.id` - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref "concepts/recipes" >}}) automate infrastructure provisioning using approved templates. - -You can specify a Recipe name that is registered in the environment or omit the name and use the "default" Recipe. - -Parameters can also optionally be specified for the Recipe. - -### Provision manually - -If you want to manually manage your infrastructure provisioning outside of Recipes, you can set `resourceProvisioning` to `'manual'` and specify `type`, `metadata`, and `version` for the Dapr component. These values must match the schema of the intended [Dapr component](https://docs.dapr.io/reference/components-reference/supported-configuration-stores/). - -## Environment variables for connections - -Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Dapr configuration store resource via connections. When a connection to Dapr configuration store named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr configuration store resource: - -| Environment variable | Example(s) | -|----------------------|------------| -| CONNECTION_MYCONNECTION_COMPONENTNAME | `myconfig` | \ No newline at end of file diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/snippets/dapr-configuration-manual.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/snippets/dapr-configuration-manual.bicep deleted file mode 100644 index 293dafcb2..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/snippets/dapr-configuration-manual.bicep +++ /dev/null @@ -1,47 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'dapr-config' - properties: { - environment: environment - } -} - -resource myapp 'Applications.Core/containers@2023-10-01-preview' = { - name: 'myapp' - properties: { - application: app.id - connections: { - daprconfig: { - source: config.id - } - } - container: { - image: 'ghcr.io/radius-project/magpiego:latest' - } - } -} - -//SAMPLE -resource config 'Applications.Dapr/configurationStores@2023-10-01-preview' = { - name: 'configstore' - properties: { - environment: environment - application: app.id - resourceProvisioning: 'manual' - type: 'configuration.redis' - metadata: { - redisHost: { - value: '' - } - redisPassword: { - value: '' - } - } - version: 'v1' - } -} -//SAMPLE diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/snippets/dapr-configuration-recipe.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/snippets/dapr-configuration-recipe.bicep deleted file mode 100644 index 6d2cc06d2..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-configurationStore/snippets/dapr-configuration-recipe.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'dapr-configstore' - properties: { - environment: environment - } -} - -//SAMPLE -resource configStore 'Applications.Dapr/configurationStores@2023-10-01-preview' = { - name: 'configstore' - properties: { - environment: environment - application: app.id - recipe: { - // Name a specific recipe to use - name: 'azure-redis-with-config' - // Set optional/required parameters (specific to the Recipe) - parameters: { - size: 'large' - } - } - } -} -//SAMPLE diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-extension/index.md b/docs/content/reference/resource-schema/dapr-schema/dapr-extension/index.md deleted file mode 100644 index 0b92ec8ec..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-extension/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -type: docs -title: "Dapr Sidecar Extension" -linkTitle: "Dapr extension" -description: "Learn how to add a Dapr sidecar with a Dapr extension" -weight: 100 -slug: "extension" -categories: "Schema" ---- - -## Overview - -The `daprSidecar` extensions adds and configures a [Dapr](https://dapr.io) sidecar to your application. - -## Extension format - -In this example a [container]({{< ref "guides/author-apps/containers" >}}) adds a Dapr extension to add a Dapr sidecar: - -{{< rad file="snippets/dapr.bicep" embed=true marker="//SAMPLE" replace-key-run="//CONTAINER" replace-value-run="container: {...}" >}} - -### Properties - -| Property | Required | Description | Example | -|----------|:--------:|-------------|---------| -| kind | y | The kind of extension. | `dapr` -| appId | n | The appId of the Dapr sidecar. | `backend` | -| appPort | n | The port your service exposes to Dapr | `3500` -| config | n | The configuration to use for the Dapr sidecar | 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 deleted file mode 100644 index 203bc4146..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-extension/snippets/dapr.bicep +++ /dev/null @@ -1,32 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//SAMPLE -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: app.id - //CONTAINER - container: { - image: 'registry/container:tag' - } - //CONTAINER - extensions: [ - { - kind: 'daprSidecar' - appId: 'frontend' - appPort: 3000 - } - ] - } -} -//SAMPLE diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/index.md b/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/index.md deleted file mode 100644 index 2e738b55e..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -type: docs -title: "Dapr Pub/Sub resource" -linkTitle: "Publish/subscribe" -description: "Learn how to use Dapr Pub/Sub in Radius" -weight: 300 -slug: "pubsub" ---- - -## Overview - -An `Applications.Dapr/pubSubBrokers` resource represents a [Dapr pub/sub](https://docs.dapr.io/developing-applications/building-blocks/pubsub/pubsub-overview/) message broker. - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/dapr-pubsub-recipe.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/dapr-pubsub-manual.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of the pub/sub. Names must contain at most 63 characters, contain only lowercase alphanumeric characters, '-', or '.', start with an alphanumeric character, and end with an alphanumeric character. | `my-pubsub` | -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| application | n | The ID of the application resource this resource belongs to. | `app.id` -| environment | y | The ID of the environment resource this resource belongs to. | `env.id` -| [resourceProvisioning](#resource-provisioning) | n | Specifies how the underlying service/resource is provisioned and managed. Options are to provision automatically via 'recipe' or provision manually via 'manual'. Selection determines which set of fields to additionally require. Defaults to 'recipe'. | `manual` -| [recipe](#recipe) | n | Configuration for the Recipe which will deploy the backing infrastructure. | [See below](#recipe) -| [resources](#resources) | n | An array of resources which underlay this resource. For example, an Azure Service Bus namespace ID if the Dapr Pub/Sub resource is leveraging Service Bus. | [See below](#resources) -| type | n | The Dapr component type. Set only when resourceProvisioning is 'manual'. | `pubsub.kafka` | -| metadata | n | Metadata object for the Dapr component. Schema must match [Dapr component](https://docs.dapr.io/reference/components-reference/supported-pubsub/). Set only when resourceProvisioning is 'manual'. | `{ brokers: { value: kafkaRoute.properties.url } }` | -| version | n | The version of the Dapr component. See [Dapr components](https://docs.dapr.io/reference/components-reference/supported-pubsub/) for available versions. Set only when resourceProvisioning is 'manual'. | `v1` | -| componentName | n | _(read-only)_ The name of the Dapr component that is generated and applied to the underlying system. Used by the Dapr SDKs or APIs to access the Dapr component. | `mypubsub` | - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| name | n | Specifies the name of the Recipe that should be deployed. If not set, the name defaults to `default`. | `name: 'azure-prod'` -| parameters | n | An object that contains a list of parameters to set on the Recipe. | `{ size: 'large' }` - -#### Resources - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| id | n | Resource ID of the supporting resource. | `account.id` - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref "concepts/recipes" >}}) automate infrastructure provisioning using approved templates. - -You can specify a Recipe name that is registered in the environment or omit the name and use the "default" Recipe. - -Parameters can also optionally be specified for the Recipe. - -### Provision manually - -If you want to manually manage your infrastructure provisioning outside of Recipes, you can set `resourceProvisioning` to `'manual'` and specify `type`, `metadata`, and `version` for the Dapr component. These values must match the schema of the intended [Dapr component](https://docs.dapr.io/reference/components-reference/supported-pubsub/). - -## Environment variables for connections - -Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Dapr pub/sub resource via connections. When a connection to Dapr pub/sub named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr pub/sub resource: - -| Environment variable | Example(s) | -|----------------------|------------| -| CONNECTION_MYCONNECTION_COMPONENTNAME | `mypubsub` | \ No newline at end of file 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 deleted file mode 100644 index d2052ddc9..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-manual.bicep +++ /dev/null @@ -1,50 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'azure-resources-dapr-pubsub-generic' - properties: { - environment: environment - } -} - -resource publisher 'Applications.Core/containers@2023-10-01-preview' = { - name: 'publisher' - properties: { - application: app.id - connections: { - daprpubsub: { - source: pubsub.id - } - } - container: { - image: 'ghcr.io/radius-project/magpiego:latest' - } - } -} - -//SAMPLE -resource pubsub 'Applications.Dapr/pubSubBrokers@2023-10-01-preview' = { - name: 'pubsub' - properties: { - environment: environment - application: app.id - resourceProvisioning: 'manual' - type: 'pubsub.kafka' - metadata: { - brokers: { - value: '' - } - authRequired: { - value: false - } - consumeRetryInternal: { - value: 1024 - } - } - version: 'v1' - } -} -//SAMPLE 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 deleted file mode 100644 index 20571a9dc..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-recipe.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'dapr-pubsub' - properties: { - environment: environment - } -} - -//SAMPLE -resource pubsub 'Applications.Dapr/pubSubBrokers@2023-10-01-preview' = { - name: 'pubsub' - properties: { - environment: environment - application: app.id - recipe: { - // Name a specific recipe to use - name: 'azure-servicebus' - // Set optional/required parameters (specific to the Recipe) - parameters: { - size: 'large' - } - } - } -} -//SAMPLE diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/index.md b/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/index.md deleted file mode 100644 index ee3e9a271..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -type: docs -title: "Dapr Secret Store resource" -linkTitle: "Secret Store" -description: "Learn how to use a Dapr Secret Store resource in Radius" -weight: 500 -categories: "Schema" -slug: "secretstore" ---- - -## Overview - -A `dapr.io/SecretStore` resource represents a [Dapr secret store](https://docs.dapr.io/developing-applications/building-blocks/secrets/secrets-overview/) topic. - -This resource will automatically create and deploy the Dapr component spec for the secret store. - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/dapr-secretstore-recipe.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/dapr-secretstore-manual.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of the resource. Names must contain at most 63 characters, contain only lowercase alphanumeric characters, '-', or '.', start with an alphanumeric character, and end with an alphanumeric character. | `my-secretstore` | -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| [resourceProvisioning](#resource-provisioning) | n | Specifies how the underlying service/resource is provisioned and managed. Options are to provision automatically via 'recipe' or provision manually via 'manual'. Selection determines which set of fields to additionally require. Defaults to 'recipe'. | `manual` -| [recipe](#recipe) | n | Configuration for the Recipe which will deploy the backing infrastructure. | [See below](#recipe) -| [resources](#resources) | n | An array of IDs of the underlying resources. | [See below](#resources) -| type | n | The Dapr component type. Used when resourceProvisioning is `manual`. | `secretstores.azure.keyvault` -| metadata | n | Metadata for the Dapr component. Schema must match [Dapr component](https://docs.dapr.io/reference/components-reference/supported-secret-stores/) | `{ vaultName: {value: 'test'} }` | -| version | n | The version of the Dapr component. See [Dapr components](https://docs.dapr.io/reference/components-reference/supported-secret-stores/) for available versions. | `v1` | -| componentName | n | _(read-only)_ The name of the Dapr component that is generated and applied to the underlying system. Used by the Dapr SDKs or APIs to access the Dapr component. | `mysecretstore` | - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| name | n | Specifies the name of the Recipe that should be deployed. If not set, the name defaults to `default`. | `name: 'azure-prod'` -| parameters | n | An object that contains a list of parameters to set on the Recipe. | `{ size: 'large' }` - -#### Resources - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| id | n | Resource ID of the supporting resource. |`keyvault.id` - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. -When no Recipe configuration is set Radius will use the Recipe registered as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set. - -### Provision manually - -If you want to manually manage your infrastructure provisioning outside of Recipes, you can set `resourceProvisioning` to `'manual'` and provide all necessary parameters and values the enable Radius to deploy or connect to the desired infrastructure. - -## Environment variables for connections - -Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Dapr secret store resource via connections. When a connection to Dapr secret store named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr secret store resource: - -| Environment variable | Example(s) | -|----------------------|------------| -| CONNECTION_MYCONNECTION_COMPONENTNAME | `mysecretstore` | \ No newline at end of file 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 deleted file mode 100644 index 532886c56..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-manual.bicep +++ /dev/null @@ -1,38 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'dapr-secretstore-generic' - properties: { - environment: environment - } -} - -//SAMPLE -resource secretstore 'Applications.Dapr/secretStores@2023-10-01-preview' = { - name: 'secretstore-generic' - properties: { - environment: environment - application: app.id - resourceProvisioning: 'manual' - type: 'secretstores.azure.keyvault' - metadata: { - vaultName: { - value: 'myvault' - } - azureTenantId: { - value: '' - } - azureClientId: { - value: '' - } - azureClientSecret: { - value: '*****' - } - } - version: 'v1' - } -} -//SAMPLE 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 deleted file mode 100644 index 056cb17b5..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-recipe.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'dapr-secretstore-generic' - properties: { - environment: environment - } -} - -//SAMPLE -resource secretstore 'Applications.Dapr/secretStores@2023-10-01-preview' = { - name: 'secretstore-generic' - properties: { - environment: environment - application: app.id - recipe: { - // Name a specific Recipe to use - name: 'secret-provider' - // Optionally set recipe parameters if needed (specific to the Recipe) - parameters: { - // .... - } - } - } -} -//SAMPLE diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/index.md b/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/index.md deleted file mode 100644 index 37207f315..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -type: docs -title: "Dapr State Store resource" -linkTitle: "State Store" -description: "Learn how to use a Dapr State Store resource in Radius" -weight: 300 -slug: "statestore" -categories: "Schema" ---- - -## Overview - -A `Applications.Dapr/stateStores` resource represents a [Dapr state store](https://docs.dapr.io/developing-applications/building-blocks/state-management/) topic. - -This resource will automatically create and deploy the Dapr component spec for the state store. - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/dapr-statestore-recipe.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/dapr-statestore-manual.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of the resource. Names must contain at most 63 characters, contain only lowercase alphanumeric characters, '-', or '.', start with an alphanumeric character, and end with an alphanumeric character. | `my-statestore` | -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| application | n | The ID of the application resource this resource belongs to. | `app.id` -| environment | y | The ID of the environment resource this resource belongs to. | `env.id` -| [resourceProvisioning](#resource-provisioning) | n | Specifies how the underlying service/resource is provisioned and managed. Options are to provision automatically via 'recipe' or provision manually via 'manual'. Selection determines which set of fields to additionally require. Defaults to 'recipe'. | `manual` -| [recipe](#recipe) | n | Configuration for the Recipe which will deploy the backing infrastructure. | [See below](#recipe) -| [resources](#resources) | n | An array of IDs of the underlying resources. | [See below](#resources) -| type | n | The Dapr component type. Used when `resourceProvisioning` is set to `manual`. | `state.couchbase` -| metadata | n | Metadata for the Dapr component. Schema must match [Dapr component](https://docs.dapr.io/reference/components-reference/supported-state-stores/). Used when `resourceProvisioning` is set to `manual`. | `{ couchbaseURL: {value: 'https://*****' }` | -| version | n | The version of the Dapr component. See [Dapr components](https://docs.dapr.io/reference/components-reference/supported-state-stores/) for available versions. Used when `resourceProvisioning` is set to `manual`. | `v1` | -| componentName | n | _(read-only)_ The name of the Dapr component that is generated and applied to the underlying system. Used by the Dapr SDKs or APIs to access the Dapr component. | `mystatestore` | - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| name | n | Specifies the name of the Recipe that should be deployed. If not set, the name defaults to `default`. | `name: 'azure-prod'` -| parameters | n | An object that contains a list of parameters to set on the Recipe. | `{ version: 'v1' }` - -#### Resources - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| id | n | Resource ID of the supporting resource. |`account::tableService::table.id` - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. -When no Recipe configuration is set Radius will use the Recipe registered as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set. - -### Provision manually - -If you want to manually manage your infrastructure provisioning outside of Recipes, you can set `resourceProvisioning` to `'manual'` and provide all necessary parameters and values and values that enable Radius to deploy or connect to the desired infrastructure. - -## Environment variables for connections - -Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Dapr state store resource via connections. When a connection to Dapr state store named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Dapr state store resource: - -| Environment variable | Example(s) | -|----------------------|------------| -| CONNECTION_MYCONNECTION_COMPONENTNAME | `mystatestore` | \ No newline at end of file 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 deleted file mode 100644 index 67eeae0cf..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-manual.bicep +++ /dev/null @@ -1,48 +0,0 @@ -extension radius - -@description('The app ID of your Radius Application. Set automatically by the rad CLI.') -param application string - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -//SAMPLE -resource statestore 'Applications.Dapr/stateStores@2023-10-01-preview' = { - name: 'statestore' - properties: { - environment: environment - application: application - resourceProvisioning: 'manual' - resources: [ - { id: account.id } - { id: account::tableServices::table.id } - ] - metadata: { - accountName: { - value: account.name - } - accountKey: { - value: account.listKeys().keys[0].value - } - tableName: { - value: account::tableServices::table.name - } - } - type: 'state.azure.tablestorage' - version: 'v1' - } -} -//SAMPLE - - -resource account 'Microsoft.Storage/storageAccounts@2019-06-01' existing = { - name: 'myaccount' - - resource tableServices 'tableServices' existing = { - name: 'default' - - resource table 'tables' existing = { - name: 'mytable' - } - } -} 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 deleted file mode 100644 index 0fee12a23..000000000 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep +++ /dev/null @@ -1,46 +0,0 @@ -extension radius - -@description('The app ID of your Radius Application. Set automatically by the rad CLI.') -param application string - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource myapp 'Applications.Core/containers@2023-10-01-preview' = { - name: 'myapp' - properties: { - application: application - container: { - image: 'ghcr.io/radius-project/magpiego:latest' - } - connections: { - statestore: { - source: statestore.id - } - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'myapp' - } - ] - } -} - -//SAMPLE -resource statestore 'Applications.Dapr/stateStores@2023-10-01-preview' = { - name: 'statestore' - properties: { - environment: environment - application: application - recipe: { - // Name a specific Recipe to use - name: 'azure-redis' - // Optionally set recipe parameters if needed (specific to the Recipe) - parameters: { - // .... - } - } - } -} -//SAMPLE diff --git a/docs/content/reference/resource-schema/databases/_index.md b/docs/content/reference/resource-schema/databases/_index.md deleted file mode 100644 index cb6a0cd1d..000000000 --- a/docs/content/reference/resource-schema/databases/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Database links" -linkTitle: "Databases" -description: "Learn what database resources are available in your application" -weight: 300 ---- diff --git a/docs/content/reference/resource-schema/databases/microsoft-sql/index.md b/docs/content/reference/resource-schema/databases/microsoft-sql/index.md deleted file mode 100644 index ad6d8e9ab..000000000 --- a/docs/content/reference/resource-schema/databases/microsoft-sql/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -type: docs -title: "Microsoft SQL Server database" -linkTitle: "Microsoft SQL" -description: "Sample application running on a user-managed Azure SQL Database" -weight: 100 -categories: "Schema" ---- - -## Overview -This application showcases how Radius can use a user-managed Azure SQL Database. - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/sql-recipe.bicep" embed=true marker="//SQL" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/sql-manual.bicep" embed=true marker="//SQL" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. | `sql` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| application | n | The ID of the application resource this resource belongs to. | `app.id` -| environment | y | The ID of the environment resource this resource belongs to. | `env.id` -| [resourceProvisioning](#resource-provisioning) | n | Specifies how the underlying service/resource is provisioned and managed. Options are to provision automatically via 'recipe' or provision manually via 'manual'. Selection determines which set of fields to additionally require. Defaults to 'recipe'. | `manual` -| [recipe](#recipe) | n | Configuration for the Recipe which will deploy the backing infrastructure. | [See below](#recipe) -| [resources](#resources) | n | An array of IDs of the underlying resources. | [See below](#resources) -| server | n | The fully qualified domain name of the SQL server. | `mydatabase.database.windows.net` -| database | n | The name of the SQL database. | `mydatabase` -| port | n | The SQL database port. | `1433` -| username | n | The username for the SQL database. | `'myusername'` -| [secrets](#secrets) | n | Secrets used when building the resource from values. | [See below](#secrets) - -### Secrets - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| connectionString | n | The connection string for the SQL database. Write only. | `Server=tcp:.database.windows.net,1433;Initial Catalog=...` -| password | n | The password for the SQL database. Write only. | `mypassword` - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| name | n | Specifies the name of the Recipe that should be deployed. If not set, the name defaults to `default`. | `name: 'azure-prod'` -| parameters | n | An object that contains a list of parameters to set on the Recipe. | `{ size: 'large' }` - -#### Resources - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| id | n | Resource ID of the supporting resource. |`sqlDb.id` - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. -When no Recipe configuration is set Radius will use the Recipe registered as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set. - -### Provision manually - -If you want to manually manage your infrastructure provisioning outside of Recipes, you can set `resourceProvisioning` to `'manual'` and provide all necessary parameters and values and values that enable Radius to deploy or connect to the desired infrastructure. - -## Environment variables for connections - -Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a Azure SQL resource via connections. When a connection to Azure SQL named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected Azure SQL resource: - -| Environment variable | Example(s) | -|----------------------|------------| -| CONNECTION_MYCONNECTION_DATABASE | `mydatabase` | -| CONNECTION_MYCONNECTION_SERVER | `mydatabase.database.windows.net` | -| CONNECTION_MYCONNECTION_PORT | `1433` | -| CONNECTION_MYCONNECTION_USERNAME | `myusername` | -| CONNECTION_MYCONNECTION_PASSWORD | `mypassword` | -| CONNECTION_MYCONNECTION_CONNECTIONSTRING | `Server=tcp:.database.windows.net,1433;Initial Catalog=...` | \ No newline at end of file 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 deleted file mode 100644 index 60e2bd6c1..000000000 --- a/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-manual.bicep +++ /dev/null @@ -1,47 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string -param username string -param port int - -@secure() -param password string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'cosmos-container' - properties: { - environment: environment - } -} - -resource sqldb 'Microsoft.Sql/servers@2021-02-01-preview' existing = { - name: 'sqldb' - resource dbinner 'databases' existing = { - name: 'cool-database' - } -} - -//SQL -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' - } - } -} -//SQL 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 deleted file mode 100644 index dba15e1a3..000000000 --- a/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-recipe.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'cosmos-container' - properties: { - environment: environment - } -} - -//SQL -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: '*******' - } - } - } -} -//SQL diff --git a/docs/content/reference/resource-schema/databases/mongodb/index.md b/docs/content/reference/resource-schema/databases/mongodb/index.md deleted file mode 100644 index a5b72857d..000000000 --- a/docs/content/reference/resource-schema/databases/mongodb/index.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -type: docs -title: "MongoDB database" -linkTitle: "MongoDB" -description: "Learn how to use a Mongo database in your application" ---- - -## Overview - -The `mongodb.com/MongoDatabase` [resource]({{< ref portable-resources >}}) represents a Mongo database. - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/mongo-recipe.bicep" embed=true marker="//MONGO" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/mongo-manual.bicep" embed=true marker="//MONGO" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. | `mongo` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| application | n | The ID of the application resource this resource belongs to. | `app.id` -| environment | y | The ID of the environment resource this resource belongs to. | `env.id` -| [resourceProvisioning](#resource-provisioning) | n | Specifies how the underlying service/resource is provisioned and managed. Options are to provision automatically via 'recipe' or provision manually via 'manual'. Selection determines which set of fields to additionally require. Defaults to 'recipe'. | `manual` -| [recipe](#recipe) | n | Configuration for the Recipe which will deploy the backing infrastructure. | [See below](#recipe) -| [resources](#resources) | n | An array of resources which underlay this resource. For example, an Azure CosmosDB database ID if the MongoDB resource is leveraging CosmosDB. | [See below](#resources) -| database | n | Database name of the target MongoDB | `mongodb-prod` -| host | n | The MongoDB host name. | `mongodb0.example.com` -| port | n | The MongoDB port. | `4242` -| username | n | The username for the MongoDB. | `'myusername'` -| [secrets](#secrets) | n | Secrets used when building the resource from values. | [See below](#secrets) - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| name | n | Specifies the name of the Recipe that should be deployed. If not set, the name defaults to `default`. | `name: 'azure-prod'` -| parameters | n | An object that contains a list of parameters to set on the Recipe. | `{ size: 'large' }` - -#### Resources - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| id | n | Resource ID of the supporting resource. | `account.id` - -#### Secrets - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| connectionString | n | The connection string for the MongoDb. Write only. | `mongodb://myDBReader:D1fficultP%40ssw0rd@mongodb0.example.com:4242/?authSource=admin` -| password | n | The password for the MongoDB. Write only. | `mypassword` - -### Methods - -The following methods are available on the Mongo database resource: - -| Method | Description | Example | -|--------|-------------|---------| -| listSecrets() | Get the [secrets](#secrets) for the MongoDb. | `listSecrets().connectionString` | - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref "concepts/recipes" >}}) automate infrastructure provisioning using approved templates. -You can specify a Recipe name that is registered in the environment or omit the name and use the "default" Recipe. - -Parameters can also optionally be specified for the Recipe. - -### Provision manually - -If you want to manually manage your infrastructure provisioning outside of Recipes, you can set `resourceProvisioning` to `'manual'` and provide all necessary parameters and values in order for Radius to be able to deploy/connect to the desired infrastructure. - -## Environment variables for connections - -Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a MongoDB resource via connections. When a connection to MongoDB named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected MongoDB resource: - -| Environment variable | Example(s) | -|----------------------|------------| -| CONNECTION_MYCONNECTION_HOST | `mongodb0.example.com` | -| CONNECTION_MYCONNECTION_PORT | `4242` | -| CONNECTION_MYCONNECTION_DATABASE | `mongodb-prod` | -| CONNECTION_MYCONNECTION_USERNAME | `myusername` | -| CONNECTION_MYCONNECTION_PASSWORD | `mypassword` | -| CONNECTION_MYCONNECTION_CONNECTIONSTRING | `mongodb://myDBReader:D1fficultP%40ssw0rd@mongodb0.example.com:4242/?authSource=admin` | \ No newline at end of file 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 deleted file mode 100644 index 08e322dc9..000000000 --- a/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-manual.bicep +++ /dev/null @@ -1,42 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource cosmosAccount 'Microsoft.DocumentDB/databaseAccounts@2022-08-15' existing = { - name: 'mycosmos' - - resource database 'mongodbDatabases' existing = { - name: 'mydb' - } - -} - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'cosmos-container-usermanaged' - properties: { - environment: environment - } -} - -//MONGO -resource db 'Applications.Datastores/mongoDatabases@2023-10-01-preview' = { - name: 'db' - properties: { - environment: environment - application: app.id - resourceProvisioning: 'manual' - host: substring(cosmosAccount.properties.documentEndpoint, 0, lastIndexOf(cosmosAccount.properties.documentEndpoint, ':')) - port: int(split(substring(cosmosAccount.properties.documentEndpoint,lastIndexOf(cosmosAccount.properties.documentEndpoint, ':') + 1), '/')[0]) - database: cosmosAccount::database.name - username: '' - resources: [ - { id: cosmosAccount.id } - ] - secrets: { - connectionString: cosmosAccount.listConnectionStrings().connectionStrings[0].connectionString - password: base64ToString(cosmosAccount.listKeys().primaryMasterKey) - } - } -} -//MONGO 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 deleted file mode 100644 index cd09b6f8b..000000000 --- a/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-recipe.bicep +++ /dev/null @@ -1,29 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'cosmos-container-usermanaged' - properties: { - environment: environment - } -} - -//MONGO -resource db 'Applications.Datastores/mongoDatabases@2023-10-01-preview' = { - name: 'db' - properties: { - environment: environment - application: app.id - recipe: { - // Name a specific Recipe to use - name: 'azure-cosmosdb' - // Set optional/required parameters (specific to the Recipe) - parameters: { - size: 'large' - } - } - } -} -//MONGO diff --git a/docs/content/reference/resource-schema/messaging/_index.md b/docs/content/reference/resource-schema/messaging/_index.md deleted file mode 100644 index e94651a91..000000000 --- a/docs/content/reference/resource-schema/messaging/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Messaging" -linkTitle: "Messaging" -description: "Learn what messaging resources are available in your application" -weight: 500 ---- diff --git a/docs/content/reference/resource-schema/messaging/rabbitmq/index.md b/docs/content/reference/resource-schema/messaging/rabbitmq/index.md deleted file mode 100644 index cf54f14b6..000000000 --- a/docs/content/reference/resource-schema/messaging/rabbitmq/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -type: docs -title: "RabbitMQ message broker" -linkTitle: "RabbitMQ" -description: "Learn how to use a RabbitMQ resource in your application" -categories: "Schema" ---- - -## Overview - -The `rabbitmq.com/MessageQueue` resource offers a [RabbitMQ message broker](https://www.rabbitmq.com/). - -## Resource format - -{{< tabs Recipe Manual >}} - -{{< codetab >}} - -{{< rad file="snippets/rabbitmq-recipe.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< codetab >}} - -{{< rad file="snippets/rabbitmq-manual.bicep" embed=true marker="//SAMPLE" >}} - -{{< /codetab >}} - -{{< /tabs >}} - -### Top-level - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. | `mongo` -| location | y | The location of your resource. See [common values]({{< ref "resource-schema.md#common-values" >}}) for more information. | `global` -| [properties](#properties) | y | Properties of the resource. | [See below](#properties) - -### Properties - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| application | n | The ID of the application resource this resource belongs to. | `app.id` -| environment | y | The ID of the environment resource this resource belongs to. | `env.id` -| [resourceProvisioning](#resource-provisioning) | n | Specifies how the underlying service/resource is provisioned and managed. Options are to provision automatically via 'recipe' or provision manually via 'manual'. Selection determines which set of fields to additionally require. Defaults to 'recipe'. | `manual` -| host | n | The hostname of the RabbitMQ instance. | `rabbitmq.hello.com` -| port | n | The port of the RabbitMQ instance. Defaults to 5672. | `5672` -| vHost | n | The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost. | `vHost` -| tls | n | Specifies whether to use SSL when connecting to the RabbitMQ instance. | `tls` -| username | n | Username to use when connecting to the target rabbitMQ. | `'myusername'` -| [recipe](#recipe) | n | Configuration for the Recipe which will deploy the backing infrastructure. | [See below](#recipe) -| [resources](#resources) | n | An array of IDs of the underlying resources. | [See below](#resources) -| queue | y | The name of the queue. | `'orders'` | -| [secrets](#secrets) | y | Configuration used to manually specify a RabbitMQ container or other service providing a RabbitMQ Queue. | See [secrets](#secrets) below. - -#### Recipe - -| Property | Required | Description | Example(s) | -|------|:--------:|-------------|---------| -| name | n | Specifies the name of the Recipe that should be deployed. If not set, the name defaults to `default`. | `name: 'azure-prod'` -| parameters | n | An object that contains a list of parameters to set on the Recipe. | `{ port: '10040' }` - -#### Resources - -| Property | Required | Description | Example(s) | -|----------|:--------:|-------------|------------| -| id | n | Resource ID of the supporting resource. |`queue.id` - -#### Secrets - -Secrets are used when defining a RabbitMQ resource with a container or external service. - -| Property | Description | Example | -|----------|-------------|---------| -| uri | The URI to the Rabbit MQ Message Queue. Write only | `'amqp://${username}:${password}@${rmqContainer.properties.hostname}:${rmqContainer.properties.port}'` -| password | The password used to connect to this RabbitMQ. Write only. | `'mypassword'` - -### Methods - -| Property | Description | Example | -|----------|-------------|---------| -| listSecrets() | Get the [secrets](#secrets) for the RabbitMQ. | `listSecrets().uri` | - -## Resource provisioning - -### Provision with a Recipe - -[Recipes]({{< ref howto-author-recipes >}}) automate infrastructure provisioning using approved templates. -When no Recipe configuration is set Radius will use the Recipe registered as the **default** in the environment for the given resource. Otherwise, a Recipe name and parameters can optionally be set. - -### Provision manually - -If you want to manually manage your infrastructure provisioning outside of Recipes, you can set `resourceProvisioning` to `'manual'` and provide all necessary parameters and values and values that enable Radius to deploy or connect to the desired infrastructure. - -## Environment variables for connections - -Other Radius resources, such as [containers]({{< ref "guides/author-apps/containers" >}}), may connect to a RabbitMQ resource via connections. When a connection to RabbitMQ named, for example, `myconnection` is declared, Radius injects values into environment variables that are then used to access the connected RabbitMQ resource: - -| Environment variable | Example(s) | -|----------------------|------------| -| CONNECTION_MYCONNECTION_QUEUE | `'orders'` | -| CONNECTION_MYCONNECTION_HOST | `'rabbitmq.svc.local.cluster'` | -| CONNECTION_MYCONNECTION_PORT | `'5672'` | -| CONNECTION_MYCONNECTION_VHOST | `'qa1'` | -| CONNECTION_MYCONNECTION_USERNAME | `'guest'` | -| CONNECTION_MYCONNECTION_TLS | `'true'` | -| CONNECTION_MYCONNECTION_URI | `'amqp://${username}:${password}@${rmqContainer.properties.hostname}:${rmqContainer.properties.port}'` | -| CONNECTION_MYCONNECTION_PASSWORD | `'password'` | \ No newline at end of file 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 deleted file mode 100644 index 67cba9033..000000000 --- a/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-manual.bicep +++ /dev/null @@ -1,37 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//SAMPLE -param rmqUsername string -@secure() -param rmqPassword string -param rmqHost string -param rmqPort int -param vHost string - -resource rabbitmq 'Applications.Messaging/rabbitmqQueues@2023-10-01-preview' = { - name: 'rabbitmq' - properties: { - environment: environment - application: app.id - resourceProvisioning: 'manual' - queue: 'radius-queue' - host: rmqHost - port: rmqPort - vHost: vHost - username: rmqUsername - secrets: { - password: rmqPassword - } - } -} -//SAMPLE 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 deleted file mode 100644 index acc9bc39a..000000000 --- a/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-recipe.bicep +++ /dev/null @@ -1,30 +0,0 @@ -extension radius - -@description('The ID of your Radius Environment. Automatically injected by the rad CLI.') -param environment string - -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'myapp' - properties: { - environment: environment - } -} - -//SAMPLE -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: '*****' - } - } - } -} -//SAMPLE - diff --git a/docs/content/reference/resource-schema/overview/index.md b/docs/content/reference/resource-schema/overview/index.md deleted file mode 100644 index 258e02139..000000000 --- a/docs/content/reference/resource-schema/overview/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -type: docs -title: "Overview: Resource schemas" -linkTitle: "Overview" -description: "Schema docs for the resources that can comprise a Radius Application" -categories: "Overview" -weight: 100 ---- - -## Common values - -The following properties and values are available across all Radius resources: - -| Key | Required | Description | Example | -|------|:--------:|-------------|---------| -| name | y | The name of your resource. | `mycontainer` -| location | y | The location of your resource. See [below](#location) for more information. The rad CLI defaults the value to 'global' for Radius resources. Direct API calls require `location` to be set to `'global'`. | `global` -| environment | y | The environment used by your resources for deployment. | `environment` | - -### Name - -The name of the resource defines how to address the resource within the context of the application. - -#### Naming constraints - -Radius resource names follow the DNS-1035 naming convention. This, plus other control-plane requirements, result in resource names that must: - -- Contain at most 63 user-entered characters -- Contain only alphanumeric characters or '-' -- Start with an alphabetic character -- End with an alphanumeric character - -#### Rendered names - -The combination of the resource name and application name results in the rendered resource name in a self-hosted Kubernetes environment. The resource group name and resource name also result in the full Universal Control Plane (UCP) identifier of the resource. - -For example, take the following values: - -- **Resource name:** `mycontainer` -- **Application name:** `myapp` -- **Resource group name:** `myrg` - -The resulting names are: - -- **Rendered Kubernetes pod name:** `myapp-mycontainer` -- **Universal Control Plane (UCP) ID:** `/planes/local/resourcegroups/myrg/providers/Applications.Core/containers/mycontainer` - -### Location - -The location property defines where to deploy a resource within the targeted platform. - -For self-hosted environments, the location property is defaulted to `global` by the rad CLI to indicate the resource is scoped to the entire underlying cluster. Direct API calls require `location` to be set to `'global'`. This is a point-in-time implementation that will be revisited in a future revision of self-hosted Kubernetes environments. - -### Environment parameter - -The `environment` string parameter is automatically injected into your Bicep template using the environment ID value specified in your default [workspace]({{< ref workspaces >}}). This value can also be overridden with the rad CLI: `rad deploy --params environment="/planes/radius/..."`. - -To access the auto-injected value, specify an `environment` string parameter in your Bicep file: - -```bicep -param environment string -``` diff --git a/docs/content/reference/resources/_index.md b/docs/content/reference/resources/_index.md new file mode 100644 index 000000000..d487d30db --- /dev/null +++ b/docs/content/reference/resources/_index.md @@ -0,0 +1,89 @@ +--- +type: docs +title: "Resource Types reference" +linkTitle: "Resource Types" +description: "Schema reference for built-in Resource Types" +weight: 200 +--- + +## Introduction + +Resource Types define the schema for the resources developers use to model their applicationsβ€”the properties you can configure, the values Radius returns, and the API versions each type supports. For a deeper explanation of what Resource Types are and how they abstract the underlying infrastructure, see the [Resource Types concepts]({{< ref "concepts/resource-types" >}}) page. + +All of the schema information on these pages is also available directly from your environment using [`rad resource-type list`]({{< ref rad_resource-type_list >}}) and [`rad resource-type show`]({{< ref rad_resource-type_show >}}), as well as through the [Radius Dashboard]({{< ref "/installation/dashboard" >}}). + +## Out-of-the-box Resource Types + +Radius provides two categories of out-of-the-box Resource Types: + +- **`Radius.Core`** types are built into Radius itself and provide its core API. These types are always present and are managed by Radius. +- **All other out-of-the-box types** are maintained in the [resource-types-contrib](https://github.com/radius-project/resource-types-contrib) repository and installed as defaults. This community-maintained repository is the home for these Resource Types and their Recipes. + +The following Resource Types are available out of the box. Every namespace except `Radius.Core` is defined in the [`defaults.yaml`](https://github.com/radius-project/radius/blob/main/deploy/manifest/defaults.yaml) manifest and sourced from resource-types-contrib: + +| Namespace | Resource Types | +|-----------|----------------| +| `Radius.Core` | `applications`, `environments`, `recipePacks`, `bicepSettings`, `terraformSettings` | +| `Radius.Compute` | `containers`, `containerImages`, `persistentVolumes`, `routes` | +| `Radius.Data` | `postgreSqlDatabases`, `mySqlDatabases`, `sqlServerDatabases`, `mongoDatabases`, `redisCaches` | +| `Radius.Messaging` | `kafka`, `rabbitMQ` | +| `Radius.AI` | `search`, `models` | +| `Radius.Security` | `secrets` | +| `Radius.Storage` | `objectStorage` | + +Because these types are pinned in a versioned manifest, the exact list can change between releases. Refer to [`defaults.yaml`](https://github.com/radius-project/radius/blob/main/deploy/manifest/defaults.yaml) for the definitive set that ships with your version of Radius, or list the types registered in your installation with: + +```bash +rad resource-type list +``` + +## Defining a Resource Type + +Custom Resource Types are defined in a YAML file. See [How to create a custom Resource Type]({{< ref "/extensibility/resource-types" >}}) for a walkthrough, or the [resource-types-contrib contribution guide](https://github.com/radius-project/resource-types-contrib/blob/main/docs/contributing/contributing-resource-types-recipes.md) to contribute a Resource Type and Recipe to the community library. A few conventions apply to every definition: + +- **Namespace** groups related Resource Types and follows the `PrimaryName.SecondaryName` format. Use a namespace that identifies your organization, such as `MyCompany.Radius`. The `Radius.` prefix is reserved for built-in and resource-types-contrib types. +- **Type names** are typically plural and camelCase, for example `externalServices`. +- **`required`** lists the properties a developer must provide. Everything else is optional. +- **`readOnly`** properties are set by the Recipe as outputs after the resource is deployed. +- **`capabilities`** opts a Resource Type into optional Radius behaviors. `ManualResourceProvisioning` is currently the only supported capability. It tells Radius that the resource is not provisioned by a Recipe: Radius stores the properties the developer provides without running a Recipe to create backing infrastructure. Omit `capabilities` for Resource Types whose infrastructure is provisioned by a Recipe. + +### Supported property types + +Every property must declare a `type`. Radius supports these types: + +- **`string`**: text values. +- **`integer`**: whole numbers. +- **`number`**: floating-point numbers. +- **`boolean`**: `true` or `false`. +- **`array`**: a list of items of a single type. +- **`object`**: either a nested set of `properties`, or a map of key/value pairs declared with `additionalProperties`. A single object cannot define both `properties` and `additionalProperties`, and `additionalProperties: true` is not allowed, so provide a schema for the map's values instead. + +To restrict a property to a fixed set of values, add an `enum`, for example `enum: ['basic', 'apiKey', 'jwt']`. + +### Sensitive properties + +Some resources need to store secrets such as API keys, passwords, or connection strings. Mark a property with the `x-radius-sensitive` annotation to have Radius protect it: + +```yaml +properties: + apiKey: + type: string + x-radius-sensitive: true +``` + +When a property is marked `x-radius-sensitive: true`, Radius: + +- **Encrypts the value at rest**, bound to the resource's ID so it cannot be reused on a different resource. +- **Redacts the value from reads**, including `rad resource show`, the Radius Dashboard, and the resource API. +- **Decrypts the value only when it is needed**, such as when passing it to the resource's Recipe. + +The annotation has two constraints: + +- It is only supported on `string` and `object` properties, a limitation of the Bicep type system. +- The property must declare an explicit `type`. + +Because Radius only decrypts sensitive values when running a Recipe, `x-radius-sensitive` is intended for Resource Types provisioned by a Recipe. For a Resource Type that uses `ManualResourceProvisioning` and has no Recipe, store secrets in a separate [`Radius.Security/secrets`]({{< ref "/reference/resources/radius.security" >}}) resource and reference it by ID instead. + +## How this section is organized + +Resource Types are organized first by namespace (such as `Radius.Core`, `Radius.Compute`, and `Radius.Data`) and then by API version (for example, `2025-08-01-preview`). Open a Resource Type to view its schema reference, which documents the resource's properties, including which fields are required and read-only. \ No newline at end of file diff --git a/docs/content/reference/resources/applications/_index.md b/docs/content/reference/resources/applications/_index.md deleted file mode 100644 index 133f42c0e..000000000 --- a/docs/content/reference/resources/applications/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: applications" -linkTitle: "applications" -description: "Detailed reference documentation for applications" ---- - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/_index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/_index.md deleted file mode 100644 index af94c70a6..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2023-10-01-preview" -linkTitle: "2023-10-01-preview" -description: "Detailed reference documentation for 2023-10-01-preview" ---- - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md deleted file mode 100644 index e67c6f168..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -type: docs -title: "Reference: applications.core/applications@2023-10-01-preview" -linkTitle: "applications" -description: "Detailed reference documentation for applications.core/applications@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | -| **extensions** | [Extension](#extension)[] | The application extension.
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [ApplicationProperties](#applicationproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/applications' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### Extension - -* **Discriminator**: kind - -#### Base Properties - -* **none** - - -#### AzureContainerInstanceExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The kind of the resource.
_(Required)_ | -| **resourceGroup** | string | The resource group of the application environment.
_(Required)_ | - -#### DaprSidecarExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(Required)_ | -| **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | -| **config** | string | Specifies the Dapr configuration to use for the resource. | -| **kind** | 'daprSidecar' | Specifies the extension of the resource
_(Required)_ | -| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | - -#### KubernetesMetadataExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | -| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | - -#### KubernetesNamespaceExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | -| **namespace** | string | The namespace of the application environment.
_(Required)_ | - -#### ManualScalingExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | -| **replicas** | int | Replica count.
_(Required)_ | - - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### ApplicationProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(Required)_ | -| **extensions** | [Extension](#extension)[] | The application extension. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md deleted file mode 100644 index 4785a1ef5..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md +++ /dev/null @@ -1,480 +0,0 @@ ---- -type: docs -title: "Reference: applications.core/containers@2023-10-01-preview" -linkTitle: "containers" -description: "Detailed reference documentation for applications.core/containers@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application
_(ReadOnly)_ | -| **connections** | [Record](#record) | Specifies a connection to another resource.
_(ReadOnly)_ | -| **container** | [Container](#container) | Definition of a container.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | -| **extensions** | [Extension](#extension)[] | Extensions spec of the resource
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers
_(ReadOnly)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [ContainerProperties](#containerproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying container resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the container
_(ReadOnly)_ | -| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | The restart policy for the underlying container
_(ReadOnly)_ | -| **runtimes** | [RuntimesProperties](#runtimesproperties) | Specifies Runtime-specific functionality
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/containers' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [ConnectionProperties](#connectionproperties) - -### ConnectionProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **disableDefaultEnvVars** | bool | default environment variable override | -| **iam** | [IamProperties](#iamproperties) | iam properties | -| **source** | string | The source of the connection
_(Required)_ | - -### IamProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure' | 'string' | The kind of IAM provider to configure
_(Required)_ | -| **roles** | string[] | RBAC permissions to be assigned on the source resource | - -### Container - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **args** | string[] | Arguments to the entrypoint. Overrides the container image's CMD | -| **command** | string[] | Entrypoint array. Overrides the container image's ENTRYPOINT | -| **env** | [Record](#record) | environment | -| **image** | string | The registry and image to download and run in your container
_(Required)_ | -| **imagePullPolicy** | 'Always' | 'IfNotPresent' | 'Never' | The pull policy for the container image | -| **livenessProbe** | [HealthProbeProperties](#healthprobeproperties) | liveness probe properties | -| **ports** | [Record](#record) | container ports | -| **readinessProbe** | [HealthProbeProperties](#healthprobeproperties) | readiness probe properties | -| **volumes** | [Record](#record) | container volumes | -| **workingDir** | string | Working directory for the container | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [EnvironmentVariable](#environmentvariable) - -### EnvironmentVariable - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **value** | string | The value of the environment variable | -| **valueFrom** | [EnvironmentVariableReference](#environmentvariablereference) | The reference to the variable | - -### EnvironmentVariableReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secretRef** | [SecretReference](#secretreference) | The secret reference
_(Required)_ | - -### SecretReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The key for the secret in the secret store.
_(Required)_ | -| **source** | string | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution.
_(Required)_ | - -### HealthProbeProperties - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **failureThreshold** | int | Threshold number of times the probe fails after which a failure would be reported | -| **initialDelaySeconds** | int | Initial delay in seconds before probing for readiness/liveness | -| **periodSeconds** | int | Interval for the readiness/liveness probe in seconds | -| **timeoutSeconds** | int | Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds | - -#### ExecHealthProbeProperties - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **command** | string | Command to execute to probe readiness/liveness
_(Required)_ | -| **kind** | 'exec' | The HealthProbeProperties kind
_(Required)_ | - -#### HttpGetHealthProbeProperties - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **containerPort** | int | The listening port number
_(Required)_ | -| **headers** | [Record](#record) | Custom HTTP headers to add to the get request | -| **kind** | 'httpGet' | The HealthProbeProperties kind
_(Required)_ | -| **path** | string | The route to make the HTTP request on
_(Required)_ | - -#### TcpHealthProbeProperties - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **containerPort** | int | The listening port number
_(Required)_ | -| **kind** | 'tcp' | The HealthProbeProperties kind
_(Required)_ | - - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [ContainerPortProperties](#containerportproperties) - -### ContainerPortProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **containerPort** | int | The listening port number
_(Required)_ | -| **port** | int | Specifies the port that will be exposed by this container. Must be set when value different from containerPort is desired | -| **protocol** | 'TCP' | 'UDP' | Protocol in use by the port | -| **scheme** | string | Specifies the URL scheme of the communication protocol. Consumers can use the scheme to construct a URL. The value defaults to 'http' or 'https' depending on the port value | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [Volume](#volume) - -### Volume - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **mountPath** | string | The path where the volume is mounted | - -#### EphemeralVolume - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'ephemeral' | The Volume kind
_(Required)_ | -| **managedStore** | 'disk' | 'memory' | Backing store for the ephemeral volume
_(Required)_ | - -#### PersistentVolume - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'persistent' | The Volume kind
_(Required)_ | -| **permission** | 'read' | 'write' | Container read/write access to the volume | -| **source** | string | The source of the volume
_(Required)_ | - - -### Extension - -* **Discriminator**: kind - -#### Base Properties - -* **none** - - -#### AzureContainerInstanceExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The kind of the resource.
_(Required)_ | -| **resourceGroup** | string | The resource group of the application environment.
_(Required)_ | - -#### DaprSidecarExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(Required)_ | -| **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | -| **config** | string | Specifies the Dapr configuration to use for the resource. | -| **kind** | 'daprSidecar' | Specifies the extension of the resource
_(Required)_ | -| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | - -#### KubernetesMetadataExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | -| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | - -#### KubernetesNamespaceExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | -| **namespace** | string | The namespace of the application environment.
_(Required)_ | - -#### ManualScalingExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | -| **replicas** | int | Replica count.
_(Required)_ | - - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### ContainerProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(Required)_ | -| **connections** | [Record](#record) | Specifies a connection to another resource. | -| **container** | [Container](#container) | Definition of a container.
_(Required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **extensions** | [Extension](#extension)[] | Extensions spec of the resource | -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying container resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the container | -| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | The restart policy for the underlying container | -| **runtimes** | [RuntimesProperties](#runtimesproperties) | Specifies Runtime-specific functionality | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [ConnectionProperties](#connectionproperties) - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### RuntimesProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **aci** | [ACIRuntimeProperties](#aciruntimeproperties) | The runtime configuration properties for ACI | -| **kubernetes** | [KubernetesRuntimeProperties](#kubernetesruntimeproperties) | The runtime configuration properties for Kubernetes | - -### ACIRuntimeProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **gatewayID** | string | The ID of the gateway that is providing L7 traffic for the container | - -### KubernetesRuntimeProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **base** | string | The serialized YAML manifest which represents the base Kubernetes resources to deploy, such as Deployment, Service, ServiceAccount, Secrets, and ConfigMaps. | -| **pod** | [KubernetesPodSpec](#kubernetespodspec) | A strategic merge patch that will be applied to the PodSpec object when this container is being deployed. | - -### KubernetesPodSpec - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md deleted file mode 100644 index 384f60c41..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md +++ /dev/null @@ -1,435 +0,0 @@ ---- -type: docs -title: "Reference: applications.core/environments@2023-10-01-preview" -linkTitle: "environments" -description: "Detailed reference documentation for applications.core/environments@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource used by application environment.
_(ReadOnly)_ | -| **extensions** | [Extension](#extension)[] | The environment extension.
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [EnvironmentProperties](#environmentproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **providers** | [Providers](#providers) | Cloud providers configuration for the environment.
_(ReadOnly)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipeConfig** | [RecipeConfigProperties](#recipeconfigproperties) | Configuration for Recipes. Defines how each type of Recipe should be configured and run.
_(ReadOnly)_ | -| **recipes** | [Record](#record) | Specifies Recipes linked to the Environment.
_(ReadOnly)_ | -| **simulated** | bool | Simulated environment.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/environments' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### Extension - -* **Discriminator**: kind - -#### Base Properties - -* **none** - - -#### AzureContainerInstanceExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The kind of the resource.
_(Required)_ | -| **resourceGroup** | string | The resource group of the application environment.
_(Required)_ | - -#### DaprSidecarExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(Required)_ | -| **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | -| **config** | string | Specifies the Dapr configuration to use for the resource. | -| **kind** | 'daprSidecar' | Specifies the extension of the resource
_(Required)_ | -| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | - -#### KubernetesMetadataExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | -| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | - -#### KubernetesNamespaceExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | -| **namespace** | string | The namespace of the application environment.
_(Required)_ | - -#### ManualScalingExtension - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | -| **replicas** | int | Replica count.
_(Required)_ | - - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### EnvironmentProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource used by application environment.
_(Required)_ | -| **extensions** | [Extension](#extension)[] | The environment extension. | -| **providers** | [Providers](#providers) | Cloud providers configuration for the environment. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipeConfig** | [RecipeConfigProperties](#recipeconfigproperties) | Configuration for Recipes. Defines how each type of Recipe should be configured and run. | -| **recipes** | [Record](#record) | Specifies Recipes linked to the Environment. | -| **simulated** | bool | Simulated environment. | - -### Providers - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider configuration. | -| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider configuration. | - -### ProvidersAws - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **scope** | string | Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'.
_(Required)_ | - -### ProvidersAzure - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **scope** | string | Target scope for Azure resources to be deployed into. For example: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup'.
_(Required)_ | - -### RecipeConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **bicep** | [BicepConfigProperties](#bicepconfigproperties) | Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment. | -| **env** | [EnvironmentVariables](#environmentvariables) | Environment variables injected during recipe execution for the recipes in the environment, currently supported for Terraform recipes. | -| **envSecrets** | [Record](#record) | Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | -| **terraform** | [TerraformConfigProperties](#terraformconfigproperties) | Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment. | - -### BicepConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **authentication** | [Record](#record) | Authentication information used to access private bicep registries, which is a map of registry hostname to secret config that contains credential information. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RegistrySecretConfig](#registrysecretconfig) - -### RegistrySecretConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secret** | string | The ID of an Applications.Core/SecretStore resource containing credential information used to authenticate private container registry.The keys in the secretstore depends on the type. | - -### EnvironmentVariables - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretReference](#secretreference) - -### SecretReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The key for the secret in the secret store.
_(Required)_ | -| **source** | string | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution.
_(Required)_ | - -### TerraformConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **authentication** | [AuthConfig](#authconfig) | Authentication information used to access private Terraform module sources. Supported module sources: Git. | -| **providers** | [Record](#record) | Configuration for Terraform Recipe Providers. Controls how Terraform interacts with cloud providers, SaaS providers, and other APIs. For more information, please see: https://developer.hashicorp.com/terraform/language/providers/configuration. | - -### AuthConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **git** | [GitAuthConfig](#gitauthconfig) | Authentication information used to access private Terraform modules from Git repository sources. | - -### GitAuthConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **pat** | [Record](#record) | Personal Access Token (PAT) configuration used to authenticate to Git platforms. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretConfig](#secretconfig) - -### SecretConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secret** | string | The ID of an Applications.Core/SecretStore resource containing the Git platform personal access token (PAT). The secret store must have a secret named 'pat', containing the PAT value. A secret named 'username' is optional, containing the username associated with the pat. By default no username is specified. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [ProviderConfigProperties](#providerconfigproperties)[] - -### ProviderConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secrets** | [Record](#record) | Sensitive data in provider configuration can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | -#### Additional Properties - -* **Additional Properties Type**: any - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretReference](#secretreference) - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [Record](#record) - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeProperties](#recipeproperties) - -### RecipeProperties - -* **Discriminator**: templateKind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **parameters** | [Record](#record) | Key/value parameters to pass to the recipe template at deployment. | -| **templatePath** | string | Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
_(Required)_ | - -#### BicepRecipeProperties - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **plainHttp** | bool | Connect to the Bicep registry using HTTP (not-HTTPS). This should be used when the registry is known not to support HTTPS, for example in a locally-hosted registry. Defaults to false (use HTTPS/TLS). | -| **templateKind** | 'bicep' | The Bicep template kind.
_(Required)_ | - -#### TerraformRecipeProperties - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | 'terraform' | The Terraform template kind.
_(Required)_ | -| **templateVersion** | string | Version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted for other module sources. | - - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [Record](#record) - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeProperties](#recipeproperties) - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md deleted file mode 100644 index d3e23d39a..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -type: docs -title: "Reference: applications.core/extenders@2023-10-01-preview" -linkTitle: "extenders" -description: "Detailed reference documentation for applications.core/extenders@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [ExtenderProperties](#extenderproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the extender portable resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **secrets** | [Record](#record) | The secrets for referenced resource
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/extenders' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### ExtenderProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the extender portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **secrets** | [Record](#record) | The secrets for referenced resource | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -#### Additional Properties - -* **Additional Properties Type**: any - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md deleted file mode 100644 index 1bc233411..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -type: docs -title: "Reference: applications.core/gateways@2023-10-01-preview" -linkTitle: "gateways" -description: "Detailed reference documentation for applications.core/gateways@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | -| **hostname** | [GatewayHostname](#gatewayhostname) | Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io.
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **internal** | bool | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet).
_(ReadOnly)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [GatewayProperties](#gatewayproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **tls** | [GatewayTls](#gatewaytls) | TLS configuration for the Gateway.
_(ReadOnly)_ | -| **type** | 'Applications.Core/gateways' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **url** | string | URL of the gateway resource. Readonly
_(ReadOnly)_ | - -### GatewayHostname - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **fullyQualifiedHostname** | string | Specify a fully-qualified domain name: myapp.mydomain.com. Mutually exclusive with 'prefix' and will take priority if both are defined. | -| **prefix** | string | Specify a prefix for the hostname: myhostname.myapp.PUBLICHOSTNAMEORIP.nip.io. Mutually exclusive with 'fullyQualifiedHostname' and will be overridden if both are defined. | - -### GatewayProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(Required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **hostname** | [GatewayHostname](#gatewayhostname) | Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io. | -| **internal** | bool | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet). | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway
_(Required)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **tls** | [GatewayTls](#gatewaytls) | TLS configuration for the Gateway. | -| **url** | string | URL of the gateway resource. Readonly
_(ReadOnly)_ | - -### GatewayRoute - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **destination** | string | The URL or id of the service to route to. Ex - 'http://myservice'. | -| **enableWebsockets** | bool | Enables websocket support for the route. Defaults to false. | -| **path** | string | The path to match the incoming request path on. Ex - /myservice. | -| **replacePrefix** | string | Optionally update the prefix when sending the request to the service. Ex - replacePrefix: '/' and path: '/myservice' will transform '/myservice/myroute' to '/myroute' | -| **timeoutPolicy** | [GatewayRouteTimeoutPolicy](#gatewayroutetimeoutpolicy) | The timeout policy for the route. | - -### GatewayRouteTimeoutPolicy - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **backendRequest** | string | The backend request timeout in duration for the route. Cannot be greater than the request timeout. | -| **request** | string | The request timeout in duration for the route. Defaults to 15 seconds. | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### GatewayTls - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **certificateFrom** | string | The resource id for the secret containing the TLS certificate and key for the gateway. | -| **minimumProtocolVersion** | '1.2' | '1.3' | TLS minimum protocol version (defaults to 1.2). | -| **sslPassthrough** | bool | If true, gateway lets the https traffic sslPassthrough to the backend servers for decryption. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/httproutes/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/httproutes/index.md deleted file mode 100644 index 48ddca8e3..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/httproutes/index.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -type: docs -title: "Reference: applications.core/httproutes@2023-10-01-preview" -linkTitle: "httproutes" -description: "Detailed reference documentation for applications.core/httproutes@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [HttpRouteProperties](#httprouteproperties) | HTTPRoute properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Core/httpRoutes' | The resource type
_(read-only, deploy-time constant)_ | - -### HttpRouteProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **hostname** | string | The internal hostname accepting traffic for the HTTP Route. Readonly. | -| **port** | int | The port number for the HTTP Route. Defaults to 80. Readonly. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | -| **scheme** | string | The scheme used for traffic. Readonly.
_(read-only)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | -| **url** | string | A stable URL that that can be used to route traffic to a resource. Readonly.
_(read-only)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | - -### TrackedResourceTags - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md deleted file mode 100644 index f58038865..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -type: docs -title: "Reference: applications.core/secretstores@2023-10-01-preview" -linkTitle: "secretstores" -description: "Detailed reference documentation for applications.core/secretstores@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [SecretStoreProperties](#secretstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/secretStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### SecretStoreProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application | -| **data** | [Record](#record) | An object to represent key-value type secrets
_(Required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **resource** | string | The resource id of external secret store. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | 'awsIRSA' | 'azureWorkloadIdentity' | 'basicAuthentication' | 'certificate' | 'generic' | The type of secret store data | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretValueProperties](#secretvalueproperties) - -### SecretValueProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **encoding** | 'base64' | 'raw' | The encoding of value | -| **value** | string | The value of secret. | -| **valueFrom** | [ValueFromProperties](#valuefromproperties) | The referenced secret in properties.resource | - -### ValueFromProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the referenced secret.
_(Required)_ | -| **version** | string | The version of the referenced secret. | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md deleted file mode 100644 index 15a9744e9..000000000 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -type: docs -title: "Reference: applications.core/volumes@2023-10-01-preview" -linkTitle: "volumes" -description: "Detailed reference documentation for applications.core/volumes@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [VolumeProperties](#volumeproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Core/volumes' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### VolumeProperties - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(Required)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | - -#### AzureKeyVaultVolumeProperties - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **certificates** | [Record](#record) | The KeyVault certificates that this volume exposes | -| **keys** | [Record](#record) | The KeyVault keys that this volume exposes | -| **kind** | 'azure.com.keyvault' | The Azure Key Vault Volume kind
_(Required)_ | -| **resource** | string | The ID of the keyvault to use for this volume resource
_(Required)_ | -| **secrets** | [Record](#record) | The KeyVault secrets that this volume exposes | - - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [CertificateObjectProperties](#certificateobjectproperties) - -### CertificateObjectProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **alias** | string | File name when written to disk | -| **certType** | 'certificate' | 'privatekey' | 'publickey' | Certificate object type to be downloaded - the certificate itself, private key or public key of the certificate | -| **encoding** | 'base64' | 'hex' | 'utf-8' | Encoding format. Default utf-8 | -| **format** | 'pem' | 'pfx' | Certificate format. Default pem | -| **name** | string | The name of the certificate
_(Required)_ | -| **version** | string | Certificate version | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [KeyObjectProperties](#keyobjectproperties) - -### KeyObjectProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **alias** | string | File name when written to disk | -| **name** | string | The name of the key
_(Required)_ | -| **version** | string | Key version | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretObjectProperties](#secretobjectproperties) - -### SecretObjectProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **alias** | string | File name when written to disk | -| **encoding** | 'base64' | 'hex' | 'utf-8' | Encoding format. Default utf-8 | -| **name** | string | The name of the secret
_(Required)_ | -| **version** | string | secret version | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.core/_index.md b/docs/content/reference/resources/applications/applications.core/_index.md deleted file mode 100644 index bc08314e3..000000000 --- a/docs/content/reference/resources/applications/applications.core/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: applications.core" -linkTitle: "applications.core" -description: "Detailed reference documentation for applications.core" ---- - diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/_index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/_index.md deleted file mode 100644 index af94c70a6..000000000 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2023-10-01-preview" -linkTitle: "2023-10-01-preview" -description: "Detailed reference documentation for 2023-10-01-preview" ---- - diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md deleted file mode 100644 index 64215d401..000000000 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -type: docs -title: "Reference: applications.dapr/configurationstores@2023-10-01-preview" -linkTitle: "configurationstores" -description: "Detailed reference documentation for applications.dapr/configurationstores@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [DaprConfigurationStoreProperties](#daprconfigurationstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Dapr/configurationStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### DaprConfigurationStoreProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | -| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the configuration store | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | -| **version** | string | Dapr component version | - -### DaprResourceAuth - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secretStore** | string | Secret store to fetch secrets from | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [MetadataValue](#metadatavalue) - -### MetadataValue - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | -| **value** | string | The plain text value of the metadata | - -### MetadataValueFromSecret - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name
_(Required)_ | -| **name** | string | Secret name in the secret store component
_(Required)_ | - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md deleted file mode 100644 index 309bbe037..000000000 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -type: docs -title: "Reference: applications.dapr/pubsubbrokers@2023-10-01-preview" -linkTitle: "pubsubbrokers" -description: "Detailed reference documentation for applications.dapr/pubsubbrokers@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [DaprPubSubBrokerProperties](#daprpubsubbrokerproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Dapr/pubSubBrokers' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### DaprPubSubBrokerProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | -| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the pubSubBroker | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | -| **version** | string | Dapr component version | - -### DaprResourceAuth - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secretStore** | string | Secret store to fetch secrets from | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [MetadataValue](#metadatavalue) - -### MetadataValue - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | -| **value** | string | The plain text value of the metadata | - -### MetadataValueFromSecret - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name
_(Required)_ | -| **name** | string | Secret name in the secret store component
_(Required)_ | - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md deleted file mode 100644 index 0cfb61b65..000000000 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -type: docs -title: "Reference: applications.dapr/secretstores@2023-10-01-preview" -linkTitle: "secretstores" -description: "Detailed reference documentation for applications.dapr/secretstores@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [DaprSecretStoreProperties](#daprsecretstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Dapr/secretStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### DaprSecretStoreProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | -| **version** | string | Dapr component version | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [MetadataValue](#metadatavalue) - -### MetadataValue - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | -| **value** | string | The plain text value of the metadata | - -### MetadataValueFromSecret - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name
_(Required)_ | -| **name** | string | Secret name in the secret store component
_(Required)_ | - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md deleted file mode 100644 index e5d0c5acd..000000000 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -type: docs -title: "Reference: applications.dapr/statestores@2023-10-01-preview" -linkTitle: "statestores" -description: "Detailed reference documentation for applications.dapr/statestores@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [DaprStateStoreProperties](#daprstatestoreproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Dapr/stateStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### DaprStateStoreProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | -| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the state store | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | -| **version** | string | Dapr component version | - -### DaprResourceAuth - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secretStore** | string | Secret store to fetch secrets from | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [MetadataValue](#metadatavalue) - -### MetadataValue - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | -| **value** | string | The plain text value of the metadata | - -### MetadataValueFromSecret - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name
_(Required)_ | -| **name** | string | Secret name in the secret store component
_(Required)_ | - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.dapr/_index.md b/docs/content/reference/resources/applications/applications.dapr/_index.md deleted file mode 100644 index 113521f71..000000000 --- a/docs/content/reference/resources/applications/applications.dapr/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: applications.dapr" -linkTitle: "applications.dapr" -description: "Detailed reference documentation for applications.dapr" ---- - diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/_index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/_index.md deleted file mode 100644 index af94c70a6..000000000 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2023-10-01-preview" -linkTitle: "2023-10-01-preview" -description: "Detailed reference documentation for 2023-10-01-preview" ---- - diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md deleted file mode 100644 index 006680c03..000000000 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -type: docs -title: "Reference: applications.datastores/mongodatabases@2023-10-01-preview" -linkTitle: "mongodatabases" -description: "Detailed reference documentation for applications.datastores/mongodatabases@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **database** | string | Database name of the target Mongo database
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **host** | string | Host name of the target Mongo database
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **port** | int | Port value of the target Mongo database
_(ReadOnly)_ | -| **properties** | [MongoDatabaseProperties](#mongodatabaseproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the MongoDB resource
_(ReadOnly)_ | -| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | Secret values provided for the resource
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Datastores/mongoDatabases' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **username** | string | Username to use when connecting to the target Mongo database
_(ReadOnly)_ | - -### MongoDatabaseProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **database** | string | Database name of the target Mongo database | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **host** | string | Host name of the target Mongo database | -| **port** | int | Port value of the target Mongo database | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the MongoDB resource | -| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | Secret values provided for the resource | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **username** | string | Username to use when connecting to the target Mongo database | - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### MongoDatabaseSecrets - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | Connection string used to connect to the target Mongo database | -| **password** | string | Password to use when connecting to the target Mongo database | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md deleted file mode 100644 index 3cc824f1b..000000000 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -type: docs -title: "Reference: applications.datastores/rediscaches@2023-10-01-preview" -linkTitle: "rediscaches" -description: "Detailed reference documentation for applications.datastores/rediscaches@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **host** | string | The host name of the target Redis cache
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **port** | int | The port value of the target Redis cache
_(ReadOnly)_ | -| **properties** | [RedisCacheProperties](#rediscacheproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the Redis resource
_(ReadOnly)_ | -| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | Secrets provided by resource
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **tls** | bool | Specifies whether to enable SSL connections to the Redis cache
_(ReadOnly)_ | -| **type** | 'Applications.Datastores/redisCaches' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **username** | string | The username for Redis cache
_(ReadOnly)_ | - -### RedisCacheProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **host** | string | The host name of the target Redis cache | -| **port** | int | The port value of the target Redis cache | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the Redis resource | -| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | Secrets provided by resource | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **tls** | bool | Specifies whether to enable SSL connections to the Redis cache | -| **username** | string | The username for Redis cache | - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### RedisCacheSecrets - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | The connection string used to connect to the Redis cache | -| **password** | string | The password for this Redis cache instance | -| **url** | string | The URL used to connect to the Redis cache | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md deleted file mode 100644 index 119939474..000000000 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -type: docs -title: "Reference: applications.datastores/sqldatabases@2023-10-01-preview" -linkTitle: "sqldatabases" -description: "Detailed reference documentation for applications.datastores/sqldatabases@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **database** | string | The name of the Sql database.
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **port** | int | Port value of the target Sql database
_(ReadOnly)_ | -| **properties** | [SqlDatabaseProperties](#sqldatabaseproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the SqlDatabase resource
_(ReadOnly)_ | -| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | Secret values provided for the resource
_(ReadOnly)_ | -| **server** | string | The fully qualified domain name of the Sql database.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Applications.Datastores/sqlDatabases' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **username** | string | Username to use when connecting to the target Sql database
_(ReadOnly)_ | - -### SqlDatabaseProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **database** | string | The name of the Sql database. | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **port** | int | Port value of the target Sql database | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the SqlDatabase resource | -| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | Secret values provided for the resource | -| **server** | string | The fully qualified domain name of the Sql database. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **username** | string | Username to use when connecting to the target Sql database | - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### SqlDatabaseSecrets - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | Connection string used to connect to the target Sql database | -| **password** | string | Password to use when connecting to the target Sql database | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.datastores/_index.md b/docs/content/reference/resources/applications/applications.datastores/_index.md deleted file mode 100644 index f4d89c7c2..000000000 --- a/docs/content/reference/resources/applications/applications.datastores/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: applications.datastores" -linkTitle: "applications.datastores" -description: "Detailed reference documentation for applications.datastores" ---- - diff --git a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/_index.md b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/_index.md deleted file mode 100644 index af94c70a6..000000000 --- a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2023-10-01-preview" -linkTitle: "2023-10-01-preview" -description: "Detailed reference documentation for 2023-10-01-preview" ---- - diff --git a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md deleted file mode 100644 index 08a912ac3..000000000 --- a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -type: docs -title: "Reference: applications.messaging/rabbitmqqueues@2023-10-01-preview" -linkTitle: "rabbitmqqueues" -description: "Detailed reference documentation for applications.messaging/rabbitmqqueues@2023-10-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
_(ReadOnly)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(ReadOnly)_ | -| **host** | string | The hostname of the RabbitMQ instance
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **port** | int | The port of the RabbitMQ instance. Defaults to 5672
_(ReadOnly)_ | -| **properties** | [RabbitMQQueueProperties](#rabbitmqqueueproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **queue** | string | The name of the queue
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the rabbitMQ resource
_(ReadOnly)_ | -| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The secrets to connect to the RabbitMQ instance
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **tls** | bool | Specifies whether to use SSL when connecting to the RabbitMQ instance
_(ReadOnly)_ | -| **type** | 'Applications.Messaging/rabbitMQQueues' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -| **username** | string | The username to use when connecting to the RabbitMQ instance
_(ReadOnly)_ | -| **vHost** | string | The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost.
_(ReadOnly)_ | - -### RabbitMQQueueProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **host** | string | The hostname of the RabbitMQ instance | -| **port** | int | The port of the RabbitMQ instance. Defaults to 5672 | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **queue** | string | The name of the queue | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | -| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the rabbitMQ resource | -| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The secrets to connect to the RabbitMQ instance | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **tls** | bool | Specifies whether to use SSL when connecting to the RabbitMQ instance | -| **username** | string | The username to use when connecting to the RabbitMQ instance | -| **vHost** | string | The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost. | - -### Recipe - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### ResourceReference - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(Required)_ | - -### RabbitMQSecrets - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **password** | string | The password used to connect to the RabbitMQ instance | -| **uri** | string | The connection URI of the RabbitMQ instance. Generated automatically from host, port, SSL, username, password, and vhost. Can be overridden with a custom value | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/applications/applications.messaging/_index.md b/docs/content/reference/resources/applications/applications.messaging/_index.md deleted file mode 100644 index 913461173..000000000 --- a/docs/content/reference/resources/applications/applications.messaging/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: applications.messaging" -linkTitle: "applications.messaging" -description: "Detailed reference documentation for applications.messaging" ---- - diff --git a/docs/content/reference/resources/radius.ai/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius.ai/2025-08-01-preview/_index.md new file mode 100644 index 000000000..13f7e0ba6 --- /dev/null +++ b/docs/content/reference/resources/radius.ai/2025-08-01-preview/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "2025-08-01-preview" +linkTitle: "2025-08-01-preview" +--- + diff --git a/docs/content/reference/resources/radius.ai/_index.md b/docs/content/reference/resources/radius.ai/_index.md new file mode 100644 index 000000000..f1a395e4f --- /dev/null +++ b/docs/content/reference/resources/radius.ai/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "Radius.AI" +linkTitle: "Radius.AI" +--- + diff --git a/docs/content/reference/resources/radius.compute/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius.compute/2025-08-01-preview/_index.md new file mode 100644 index 000000000..13f7e0ba6 --- /dev/null +++ b/docs/content/reference/resources/radius.compute/2025-08-01-preview/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "2025-08-01-preview" +linkTitle: "2025-08-01-preview" +--- + diff --git a/docs/content/reference/resources/radius.compute/_index.md b/docs/content/reference/resources/radius.compute/_index.md new file mode 100644 index 000000000..b0b110d50 --- /dev/null +++ b/docs/content/reference/resources/radius.compute/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "Radius.Compute" +linkTitle: "Radius.Compute" +--- + diff --git a/docs/content/reference/resources/radius.core/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius.core/2025-08-01-preview/_index.md new file mode 100644 index 000000000..13f7e0ba6 --- /dev/null +++ b/docs/content/reference/resources/radius.core/2025-08-01-preview/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "2025-08-01-preview" +linkTitle: "2025-08-01-preview" +--- + diff --git a/docs/content/reference/resources/radius.core/2025-08-01-preview/applications/index.md b/docs/content/reference/resources/radius.core/2025-08-01-preview/applications/index.md new file mode 100644 index 000000000..b1e99b2ff --- /dev/null +++ b/docs/content/reference/resources/radius.core/2025-08-01-preview/applications/index.md @@ -0,0 +1,108 @@ +--- +type: docs +title: "Radius.Core/applications@2025-08-01-preview" +linkTitle: "Applications" +--- + +{{< schemaExample >}} + +## Description + +The `Radius.Core/applications` Resource Type represents a Radius Application: a logical grouping of the resources that make up a single Application, such as containers, databases, and message queues, along with the connections between them. Radius uses the Application to build the application graph, apply shared configuration, and manage its resources together throughout their lifecycle. + +### Defining an Application + +An Application is always deployed to a Radius Environment, which is supplied through the `environment` property. To define an Application, add a `Radius.Core/applications` resource to your application definition Bicep file. + +```bicep +extension radius + +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string + +resource myApp 'Radius.Core/applications@2025-08-01-preview' = { + name: 'my-app' + properties: { + environment: environment + } +} +``` + +### Deploying an Application + +An Application is deployed with the `rad deploy` command, which deploys the Application together with the resources that belong to it: + +```bash +rad deploy ./app.bicep +``` + +### Adding resources to an Application + +Resources are composed into an Application by setting their `application` property to the Application's ID. For example, to add a Container to this Application, add the following to the application definition Bicep file and set `application: myApp.id`: + +```bicep +resource frontend 'Radius.Compute/containers@2025-08-01-preview' = { + name: 'frontend' + properties: { + environment: environment + application: myApp.id + containers: { + frontend: { + image: 'ghcr.io/my-org/frontend:latest' + } + } + } +} +``` + +For more information, see the Radius documentation at https://docs.radapp.io. + +## Top-Level Properties + +| Property | Type | Description | +|----------|------|-------------| +| `environment` | string | (Required) Fully qualified resource ID of the environment the application is deployed to | +| `provisioningState` | string | (Read Only) The status of the Application resource within the Radius control plane. Does not include the other resources that compose the Application.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `status` | [object](#status) | (Read Only) Deployment details for the Application, including any output resources Radius created for it. | + +## Object Properties + +### `status` {#status} + +| Property | Type | Description | +|----------|------|-------------| +| `compute` | [object](#status-compute) | The compute resource associated with the resource. | +| `outputResources` | [object](#status-outputresources)[] | Properties of an output resource | +| `recipe` | [object](#status-recipe) | The recipe data at the time of deployment | + +### `status.compute` {#status-compute} + +| Property | Type | Description | +|----------|------|-------------| +| `identity` | [object](#status-compute-identity) | Configuration for supported external identity providers | +| `resourceId` | string | The resource id of the compute resource for application environment. | + +### `status.outputResources` {#status-outputresources} + +| Property | Type | Description | +|----------|------|-------------| +| `id` | string | The UCP resource ID of the underlying resource. | +| `localId` | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| `radiusManaged` | boolean | Determines whether Radius manages the lifecycle of the underlying resource. | + +### `status.recipe` {#status-recipe} + +| Property | Type | Description | +|----------|------|-------------| +| `templateKind` | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. | +| `templatePath` | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. | +| `templateVersion` | string | TemplateVersion is the version number of the template. | + +### `status.compute.identity` {#status-compute-identity} + +| Property | Type | Description | +|----------|------|-------------| +| `kind` | string | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | The list of user assigned managed identities | +| `oidcIssuer` | string | The URI for your compute platform's OIDC issuer | +| `resource` | string | The resource ID of the provisioned identity | diff --git a/docs/content/reference/resources/radius.core/2025-08-01-preview/bicepsettings/index.md b/docs/content/reference/resources/radius.core/2025-08-01-preview/bicepsettings/index.md new file mode 100644 index 000000000..d961d2ae0 --- /dev/null +++ b/docs/content/reference/resources/radius.core/2025-08-01-preview/bicepsettings/index.md @@ -0,0 +1,98 @@ +--- +type: docs +title: "Radius.Core/bicepSettings@2025-08-01-preview" +linkTitle: "BicepSettings" +--- + +{{< schemaExample >}} + +## Description + +The `Radius.Core/bicepSettings` Resource Type holds reusable Bicep engine settings that Environments apply when running Bicep Recipes. Its primary use is authenticating to private Bicep registries: OCI registries, such as Azure Container Registry, that host the Recipe templates referenced by a Recipe Pack. + +Platform engineers define a `Radius.Core/bicepSettings` resource once and reference it from any Environment whose Recipes pull templates from a private registry. + +### Defining Bicep settings + +Configure `registryAuthentications`, keyed by registry hostname. When a Recipe template is pulled from a matching host, Radius authenticates using the configured method. The example below uses basic authentication, reading the username and password from a secret: + +```bicep +extension radius + +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string + +resource registrySecret 'Radius.Security/secrets@2025-08-01-preview' = { + name: 'registry-credentials' + properties: { + environment: environment + data: { + username: { value: 'my-username' } + password: { value: 'my-password' } + } + } +} + +resource bicepRegistry 'Radius.Core/bicepSettings@2025-08-01-preview' = { + name: 'private-registry' + properties: { + registryAuthentications: { + 'corp.azurecr.io': { + authenticationMethod: 'BasicAuth' + basicAuthSecretId: registrySecret.id + } + } + } +} +``` + +Basic authentication is supported via `BasicAuth` (username and password from a secret). `AwsIrsa` and `AzureWI` will be implemented in the future. + +### Deploying Bicep settings + +Deploy the settings resource with the `rad deploy` command: + +```bash +rad deploy ./bicep-settings.bicep +``` + +### Referencing Bicep settings from an Environment + +Reference the settings from an Environment by setting its `bicepSettings` property to the resource ID. Every Bicep Recipe run in that Environment then uses the configured registry authentication: + +```bicep +extension radius + +resource bicepRegistry 'Radius.Core/bicepSettings@2025-08-01-preview' existing = { + name: 'private-registry' +} + +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + bicepSettings: bicepRegistry.id + } +} +``` + +For more information, see the Radius documentation at https://docs.radapp.io. + +## Top-Level Properties + +| Property | Type | Description | +|----------|------|-------------| +| `provisioningState` | string | (Read Only) The status of the Bicep settings resource within the Radius control plane.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `referencedBy` | string array | (Read Only) Resource IDs of the Environments that reference this Bicep settings resource. | +| `registryAuthentications` | [object](#registryauthentications) | (Optional) Authentication for private Bicep registries that host Recipe templates, keyed by registry hostname such as `corp.acr.io`. Radius matches a registry by the hostname in the Recipe source. | + +## Object Properties + +### `registryAuthentications` {#registryauthentications} + +| Property | Type | Description | +|----------|------|-------------| +| `authenticationMethod` | string | (Optional) How Radius authenticates to the registry.
Allowed values: `AwsIrsa`, `AzureWI`, `BasicAuth`. | +| `awsIamRoleArn` | string | (Optional) AWS IAM Role ARN for IRSA authentication. Required when `authenticationMethod` is `AwsIrsa`. | +| `azureWiClientId` | string | (Optional) Azure Workload Identity client ID. Required when `authenticationMethod` is `AzureWI`. | +| `azureWiTenantId` | string | (Optional) Azure Workload Identity tenant ID. Required when `authenticationMethod` is `AzureWI`. | +| `basicAuthSecretId` | string | (Optional) The ID of a `Radius.Security/secrets` resource containing the username and password. Required when `authenticationMethod` is `BasicAuth`. | diff --git a/docs/content/reference/resources/radius.core/2025-08-01-preview/environments/index.md b/docs/content/reference/resources/radius.core/2025-08-01-preview/environments/index.md new file mode 100644 index 000000000..499457d2a --- /dev/null +++ b/docs/content/reference/resources/radius.core/2025-08-01-preview/environments/index.md @@ -0,0 +1,163 @@ +--- +type: docs +title: "Radius.Core/environments@2025-08-01-preview" +linkTitle: "Environments" +--- + +{{< schemaExample >}} + +## Description + +The `Radius.Core/environments` Resource Type represents a Radius Environment: the deployment target that platform engineers configure for their developers. Every Radius Application is deployed to an Environment through its `environment` property. + +An Environment defines three things for the Applications deployed to it: + +- **Where resources are deployed**: the target compute platform and cloud provider accounts, set through the `providers` property. +- **Which Recipes are used**: the Recipe Packs whose Recipes provision the infrastructure backing application resources, set through the `recipePacks` property. +- **Advanced Terraform and Bicep settings**: environment-wide Recipe parameters and Terraform or Bicep engine configuration applied when Recipes run. + +### Defining an Environment + +The simplest Environment can be created directly with the `rad environment create` command, without a Bicep file: + +```bash +rad environment create my-environment +``` + +For more advanced configurations, define an Environment as a `Radius.Core/environments` resource in a Bicep file. For example: + +```bicep +extension radius + +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + recipePacks: [ + myRecipePack.id + ] + providers: { + kubernetes: { + namespace: 'my-namespace' + } + } + } +} + +resource myRecipePack 'Radius.Core/recipePacks@2025-08-01-preview' existing = { + name: 'my-recipe-pack' +} +``` + +Both properties are optional. When you create an Environment with the Radius CLI, an omitted `providers` defaults to Kubernetes in the `default` namespace, and an omitted `recipePacks` defaults to the `default` Recipe Pack in the `default` resource group. + +### Deploying an Environment + +Deploy a defined Environment with the `rad deploy` command: + +```bash +rad deploy ./environment.bicep +``` + +### Cloud providers + +To use Recipes that provision resources in a cloud provider, you must configure that provider's account details on the Environment by setting the `providers` property. For AWS, set the account ID and the region resources are deployed to: + +```bicep +extension radius + +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + providers: { + aws: { + accountId: '123456789012' + region: 'us-west-2' + } + } + } +} +``` + +For Azure, set the subscription ID and the name of the resource group that resources are deployed to: + +```bicep +extension radius + +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + providers: { + azure: { + subscriptionId: '00000000-0000-0000-0000-000000000000' + resourceGroupName: 'my-resource-group' + } + } + } +} +``` + +The `providers` property selects the target account, but the credentials Radius uses to authenticate to AWS and Azure are configured separately with the `rad credential register` command. + +### Recipe Packs + +A Recipe Pack is a collection of Recipes, defined as a separate `Radius.Core/recipePacks` resource. A Recipe is an infrastructure-as-code module, a Terraform module or Bicep template, that provisions the infrastructure backing an application resource. Reference one or more Recipe Packs by their resource IDs in the `recipePacks` property to control which Recipes are used. See the `Radius.Core/recipePacks` documentation for details. + +Use `recipeParameters` to pass environment-specific parameters to the Recipes defined in the referenced Recipe Packs, for example to standardize configuration such as SKUs or instance sizes across an Environment. + +### Advanced Terraform and Bicep settings + +For advanced Terraform and Bicep settings, such as private module sources and registry authentication, reference a `Radius.Core/terraformSettings` or `Radius.Core/bicepSettings` resource from the `terraformSettings` and `bicepSettings` properties. + +For more information, see the Radius documentation at https://docs.radapp.io. + +## Top-Level Properties + +| Property | Type | Description | +|----------|------|-------------| +| `bicepSettings` | string | (Optional) Resource ID of a `Radius.Core/bicepSettings` resource that supplies Bicep engine settings, such as private registry authentication, used when running Bicep Recipes in this Environment. | +| `providers` | [object](#providers) | (Optional) Target compute platform and cloud provider accounts that resources are deployed into. When created with the Radius CLI, defaults to Kubernetes in the `default` namespace. | +| `provisioningState` | string | (Read Only) The status of the Environment resource within the Radius control plane. Does not include the resources deployed to the Environment.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipePacks` | string array | (Optional) Resource IDs of the Recipe Packs this Environment uses to provision infrastructure for application resources. When created with the Radius CLI, defaults to the `default` Recipe Pack in the `default` resource group. | +| `recipeParameters` | object | (Optional) Parameters passed to Recipes when they run, keyed by resource type. Values here override the default parameters defined in the Recipe Pack for every resource of that type deployed to this Environment. | +| `simulated` | boolean | (Optional) When true, the Environment is simulated and does not deploy real infrastructure. Recipes are evaluated but no resources are provisioned, which is useful for validating application definitions. Defaults to `false` if not specified. | +| `terraformSettings` | string | (Optional) Resource ID of a `Radius.Core/terraformSettings` resource that supplies Terraform CLI settings, such as private registry credentials, used when running Terraform Recipes in this Environment. | + +## Object Properties + +### `providers` {#providers} + +| Property | Type | Description | +|----------|------|-------------| +| `aws` | [object](#providers-aws) | (Optional) Configuration for deploying resources to AWS. | +| `azure` | [object](#providers-azure) | (Optional) Configuration for deploying resources to Azure. | +| `kubernetes` | [object](#providers-kubernetes) | (Optional) Configuration for deploying resources to Kubernetes. | + +### `providers.aws` {#providers-aws} + +| Property | Type | Description | +|----------|------|-------------| +| `accountId` | string | (Required) ID of the AWS account that resources are deployed into. | +| `region` | string | (Required) AWS region that resources are deployed into. | + +### `providers.azure` {#providers-azure} + +| Property | Type | Description | +|----------|------|-------------| +| `identity` | [object](#providers-azure-identity) | (Optional) Managed or workload identity Radius uses to authenticate to Azure when deploying resources. | +| `resourceGroupName` | string | (Optional) Name of the Azure resource group that resources are deployed into. Most Bicep and Terraform Recipes expect a resource group in the deployment context, so set this whenever deploying Azure resources. | +| `subscriptionId` | string | (Required) ID of the Azure subscription that resources are deployed into. | + +### `providers.kubernetes` {#providers-kubernetes} + +| Property | Type | Description | +|----------|------|-------------| +| `namespace` | string | (Required) Kubernetes namespace that workloads are deployed into. | + +### `providers.azure.identity` {#providers-azure-identity} + +| Property | Type | Description | +|----------|------|-------------| +| `kind` | string | kind of identity setting
Allowed values: `azure.com.workload`, `systemAssigned`, `systemAssignedUserAssigned`, `undefined`, `userAssigned`. | +| `managedIdentity` | string array | The list of user assigned managed identities | +| `oidcIssuer` | string | The URI for your compute platform's OIDC issuer | +| `resource` | string | The resource ID of the provisioned identity | diff --git a/docs/content/reference/resources/radius.core/2025-08-01-preview/recipepacks/index.md b/docs/content/reference/resources/radius.core/2025-08-01-preview/recipepacks/index.md new file mode 100644 index 000000000..79351f7a3 --- /dev/null +++ b/docs/content/reference/resources/radius.core/2025-08-01-preview/recipepacks/index.md @@ -0,0 +1,118 @@ +--- +type: docs +title: "Radius.Core/recipePacks@2025-08-01-preview" +linkTitle: "RecipePacks" +--- + +{{< schemaExample >}} + +## Description + +The `Radius.Core/recipePacks` Resource Type represents a Recipe Pack: a named collection of Recipes that platform engineers assign to an Environment. A Recipe maps a resource type (such as `Radius.Data/redisCaches`) to an infrastructure-as-code module, a Terraform module or Bicep template, that provisions the infrastructure backing that resource when a developer deploys it. + +A Recipe Pack is defined as its own resource and referenced from an Environment's `recipePacks` property, so one Recipe Pack can be shared across many Environments. + +### Defining a Recipe Pack + +Each entry in the `recipes` map is keyed by resource type. Set the recipe `kind` (`bicep` or `terraform`) and its `source` (an OCI registry reference for Bicep recipes, or a module source for Terraform recipes). + +```bicep +extension radius + +resource dataRecipes 'Radius.Core/recipePacks@2025-08-01-preview' = { + name: 'data-recipes' + properties: { + recipes: { + 'Radius.Data/redisCaches': { + kind: 'bicep' + source: 'ghcr.io/my-org/recipes/redis:latest' + } + 'Radius.Data/postgreSqlDatabases': { + kind: 'terraform' + source: 'git::https://github.com/my-org/recipes//postgresql' + } + } + } +} +``` + +### Recipe parameters + +Each Recipe can declare default `parameters` that are passed to its module. Platform engineers set baseline values here, and developers get them automatically. An Environment can override these values per resource type through its `recipeParameters` property. + +```bicep +resource dataRecipes 'Radius.Core/recipePacks@2025-08-01-preview' = { + name: 'data-recipes' + properties: { + recipes: { + 'Radius.Data/redisCaches': { + kind: 'bicep' + source: 'ghcr.io/my-org/recipes/redis:latest' + parameters: { + sku: 'Standard' + capacity: 1 + } + } + } + } +} +``` + +### Deploying a Recipe Pack + +Deploy the Bicep file with `rad deploy` to create the Recipe Pack resource. Once deployed, list and inspect Recipe Packs with the `rad recipe-pack list` and `rad recipe-pack show` commands. + +### Referencing a Recipe Pack from an Environment + +An Environment references a Recipe Pack through its `recipePacks` property. When the Recipe Pack and the Environment are deployed to the same resource group, declare it as an `existing` resource and reference its `.id`: + +```bicep +extension radius + +resource dataRecipes 'Radius.Core/recipePacks@2025-08-01-preview' existing = { + name: 'data-recipes' +} + +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + recipePacks: [ + dataRecipes.id + ] + } +} +``` + +To reference a Recipe Pack in a different resource group, use its full resource ID instead: + +```bicep +recipePacks: [ + '/planes/radius/local/resourceGroups/shared/providers/Radius.Core/recipePacks/data-recipes' +] +``` + +Radius is installed with a `default` Recipe Pack in the `default` resource group. When you create an Environment with the Radius CLI and do not set `recipePacks`, the Environment uses this `default` Recipe Pack. + +Prebuilt Recipe Packs and the Recipes they reference are published in the [resource-types-contrib](https://github.com/radius-project/resource-types-contrib) repository. + +For more information, see the Radius documentation at https://docs.radapp.io. + +## Top-Level Properties + +| Property | Type | Description | +|----------|------|-------------| +| `provisioningState` | string | (Read Only) The status of the Recipe Pack resource within the Radius control plane.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `recipes` | [object](#recipes) | (Required) The Recipes in this pack, keyed by the resource type each Recipe provisions. Each key is a resource type such as `Radius.Data/redisCaches`. | +| `referencedBy` | string array | (Read Only) Resource IDs of the Environments that reference this Recipe Pack. | + +## Object Properties + +### `recipes` {#recipes} + +| Property | Type | Description | +|----------|------|-------------| +| `kind` | string | (Required) The kind of Recipe, which determines how Radius runs it.
Allowed values: `bicep`, `terraform`. | +| `outputs` | object | (Optional) Maps the module outputs onto the resource type properties for recipes that point directly at a Bicep or Terraform module. Each value is the module output name for a non-secret property. Under the reserved `secrets` key a nested object maps secret property names to module output names and always routes those outputs to the resource secret outputs. | +| `parameters` | object | (Optional) Default parameter values passed to the Recipe when it runs. An Environment can override these per resource type through its `recipeParameters` property. | +| `plainHttp` | boolean | (Optional) Connect to the source using HTTP instead of HTTPS. Use this only when the source does not support HTTPS such as a locally hosted registry for Bicep recipes. Defaults to `false` if not specified. | +| `source` | string | (Required) Location of the Recipe. For Bicep Recipes this is an OCI registry reference. For Terraform Recipes this is the module source such as a Git URL or a Terraform registry module. | diff --git a/docs/content/reference/resources/radius.core/2025-08-01-preview/terraformsettings/index.md b/docs/content/reference/resources/radius.core/2025-08-01-preview/terraformsettings/index.md new file mode 100644 index 000000000..7330c879b --- /dev/null +++ b/docs/content/reference/resources/radius.core/2025-08-01-preview/terraformsettings/index.md @@ -0,0 +1,163 @@ +--- +type: docs +title: "Radius.Core/terraformSettings@2025-08-01-preview" +linkTitle: "TerraformSettings" +--- + +{{< schemaExample >}} + +## Description + +The `Radius.Core/terraformSettings` Resource Type holds reusable Terraform CLI settings that Environments apply when running Terraform Recipes. Its primary use is authenticating to private Terraform registries that host the modules referenced by a Recipe Pack, along with configuring provider installation and injecting environment variables during Recipe execution. + +Platform engineers define a `Radius.Core/terraformSettings` resource once and reference it from any Environment whose Recipes pull modules from a private registry. + +### Defining Terraform settings + +Configure `terraformrc.credentials`, keyed by registry hostname, to authenticate to a private Terraform registry. Each entry points to a secret whose `token` key holds the registry token: + +```bicep +extension radius + +@description('The Radius Environment ID. Injected automatically by the rad CLI.') +param environment string + +resource registrySecret 'Radius.Security/secrets@2025-08-01-preview' = { + name: 'terraform-registry-token' + properties: { + environment: environment + data: { + token: { value: 'my-registry-token' } + } + } +} + +resource terraformRegistry 'Radius.Core/terraformSettings@2025-08-01-preview' = { + name: 'private-registry' + properties: { + terraformrc: { + credentials: { + 'app.terraform.io': { + secret: registrySecret.id + } + } + } + } +} +``` + +Two other settings are available: provider installation and environment variables. + +### Provider installation + +In air-gapped or internal environments, use `terraformrc.providerInstallation` to install providers from a network mirror instead of the public registry. Set the mirror `url`, optionally narrow it with `include` or `exclude` provider address patterns, and use `direct` to control which providers are still downloaded directly: + +```bicep +resource providerMirror 'Radius.Core/terraformSettings@2025-08-01-preview' = { + name: 'internal-mirror' + properties: { + terraformrc: { + providerInstallation: { + networkMirror: { + url: 'https://terraform.corp.example.com/providers/' + include: ['*'] + } + direct: { + exclude: ['*'] + } + } + } + } +} +``` + +### Environment variables + +Use `env` to inject environment variables into every Terraform Recipe run, for example to raise the Terraform log level for troubleshooting or to tune CLI behavior: + +```bicep +resource terraformLogging 'Radius.Core/terraformSettings@2025-08-01-preview' = { + name: 'terraform-logging' + properties: { + env: { + TF_LOG: 'TRACE' + TF_REGISTRY_CLIENT_TIMEOUT: '15' + } + } +} +``` + +### Deploying Terraform settings + +Deploy the settings resource with the `rad deploy` command: + +```bash +rad deploy ./terraform-settings.bicep +``` + +### Referencing Terraform settings from an Environment + +Reference the settings from an Environment by setting its `terraformSettings` property to the resource ID. Every Terraform Recipe run in that Environment then uses the configured registry credentials: + +```bicep +extension radius + +resource terraformRegistry 'Radius.Core/terraformSettings@2025-08-01-preview' existing = { + name: 'private-registry' +} + +resource myEnvironment 'Radius.Core/environments@2025-08-01-preview' = { + name: 'my-environment' + properties: { + terraformSettings: terraformRegistry.id + } +} +``` + +For more information, see the Radius documentation at https://docs.radapp.io. + +## Top-Level Properties + +| Property | Type | Description | +|----------|------|-------------| +| `env` | object | (Optional) Environment variables injected into the Terraform process during Recipe execution. | +| `provisioningState` | string | (Read Only) The status of the Terraform settings resource within the Radius control plane.
Allowed values: `Accepted`, `Canceled`, `Creating`, `Deleting`, `Failed`, `Provisioning`, `Succeeded`, `Updating`. | +| `referencedBy` | string array | (Read Only) Resource IDs of the Environments that reference this Terraform settings resource. | +| `terraformrc` | [object](#terraformrc) | (Optional) Settings for the Terraform CLI configuration file. Radius renders these into a `.terraformrc` file used when running Terraform Recipes. | + +## Object Properties + +### `terraformrc` {#terraformrc} + +| Property | Type | Description | +|----------|------|-------------| +| `credentials` | [object](#terraformrc-credentials) | (Optional) Credentials for authenticating to private Terraform registries such as `app.terraform.io`. Maps a registry hostname to its credential configuration. This authenticates to Terraform CLI registries over HTTP and does not authenticate Git-based module sources, which use a separate mechanism. | +| `providerInstallation` | [object](#terraformrc-providerinstallation) | (Optional) Controls where Terraform installs providers from, such as a network mirror instead of the public registry. | + +### `terraformrc.credentials` {#terraformrc-credentials} + +| Property | Type | Description | +|----------|------|-------------| +| `secret` | string | (Optional) The ID of a `Radius.Security/secrets` resource containing the authentication token. The secret must have a key named `token`. | + +### `terraformrc.providerInstallation` {#terraformrc-providerinstallation} + +| Property | Type | Description | +|----------|------|-------------| +| `direct` | [object](#terraformrc-providerinstallation-direct) | (Optional) Providers to install directly from the public registry rather than a mirror. | +| `networkMirror` | [object](#terraformrc-providerinstallation-networkmirror) | (Optional) A network mirror to install providers from instead of the public registry. | + +### `terraformrc.providerInstallation.direct` {#terraformrc-providerinstallation-direct} + +| Property | Type | Description | +|----------|------|-------------| +| `exclude` | string array | (Optional) Provider address patterns to exclude from direct installation. | +| `include` | string array | (Optional) Provider address patterns to include for direct installation. | + +### `terraformrc.providerInstallation.networkMirror` {#terraformrc-providerinstallation-networkmirror} + +| Property | Type | Description | +|----------|------|-------------| +| `exclude` | string array | (Optional) Provider address patterns to exclude from this mirror. | +| `include` | string array | (Optional) Provider address patterns to include from this mirror. | +| `url` | string | (Optional) The URL of the provider mirror. | diff --git a/docs/content/reference/resources/radius.core/_index.md b/docs/content/reference/resources/radius.core/_index.md new file mode 100644 index 000000000..d7c870707 --- /dev/null +++ b/docs/content/reference/resources/radius.core/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "Radius.Core" +linkTitle: "Radius.Core" +--- + diff --git a/docs/content/reference/resources/radius.data/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius.data/2025-08-01-preview/_index.md new file mode 100644 index 000000000..13f7e0ba6 --- /dev/null +++ b/docs/content/reference/resources/radius.data/2025-08-01-preview/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "2025-08-01-preview" +linkTitle: "2025-08-01-preview" +--- + diff --git a/docs/content/reference/resources/radius.data/_index.md b/docs/content/reference/resources/radius.data/_index.md new file mode 100644 index 000000000..e4064a813 --- /dev/null +++ b/docs/content/reference/resources/radius.data/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "Radius.Data" +linkTitle: "Radius.Data" +--- + diff --git a/docs/content/reference/resources/radius.messaging/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius.messaging/2025-08-01-preview/_index.md new file mode 100644 index 000000000..13f7e0ba6 --- /dev/null +++ b/docs/content/reference/resources/radius.messaging/2025-08-01-preview/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "2025-08-01-preview" +linkTitle: "2025-08-01-preview" +--- + diff --git a/docs/content/reference/resources/radius.messaging/_index.md b/docs/content/reference/resources/radius.messaging/_index.md new file mode 100644 index 000000000..cb80924e6 --- /dev/null +++ b/docs/content/reference/resources/radius.messaging/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "Radius.Messaging" +linkTitle: "Radius.Messaging" +--- + diff --git a/docs/content/reference/resources/radius.security/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius.security/2025-08-01-preview/_index.md new file mode 100644 index 000000000..13f7e0ba6 --- /dev/null +++ b/docs/content/reference/resources/radius.security/2025-08-01-preview/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "2025-08-01-preview" +linkTitle: "2025-08-01-preview" +--- + diff --git a/docs/content/reference/resources/radius.security/_index.md b/docs/content/reference/resources/radius.security/_index.md new file mode 100644 index 000000000..571abf059 --- /dev/null +++ b/docs/content/reference/resources/radius.security/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "Radius.Security" +linkTitle: "Radius.Security" +--- + diff --git a/docs/content/reference/resources/radius.storage/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius.storage/2025-08-01-preview/_index.md new file mode 100644 index 000000000..13f7e0ba6 --- /dev/null +++ b/docs/content/reference/resources/radius.storage/2025-08-01-preview/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "2025-08-01-preview" +linkTitle: "2025-08-01-preview" +--- + diff --git a/docs/content/reference/resources/radius.storage/_index.md b/docs/content/reference/resources/radius.storage/_index.md new file mode 100644 index 000000000..29418003e --- /dev/null +++ b/docs/content/reference/resources/radius.storage/_index.md @@ -0,0 +1,6 @@ +--- +type: docs +title: "Radius.Storage" +linkTitle: "Radius.Storage" +--- + diff --git a/docs/content/reference/resources/radius/_index.md b/docs/content/reference/resources/radius/_index.md deleted file mode 100644 index 01d5d440e..000000000 --- a/docs/content/reference/resources/radius/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: radius" -linkTitle: "radius" -description: "Detailed reference documentation for radius" ---- - diff --git a/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/_index.md deleted file mode 100644 index b3d055dde..000000000 --- a/docs/content/reference/resources/radius/radius.ai/2025-08-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2025-08-01-preview" -linkTitle: "2025-08-01-preview" -description: "Detailed reference documentation for 2025-08-01-preview" ---- - diff --git a/docs/content/reference/resources/radius/radius.ai/_index.md b/docs/content/reference/resources/radius/radius.ai/_index.md deleted file mode 100644 index a522abb18..000000000 --- a/docs/content/reference/resources/radius/radius.ai/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: radius.ai" -linkTitle: "radius.ai" -description: "Detailed reference documentation for radius.ai" ---- - diff --git a/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/_index.md deleted file mode 100644 index b3d055dde..000000000 --- a/docs/content/reference/resources/radius/radius.compute/2025-08-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2025-08-01-preview" -linkTitle: "2025-08-01-preview" -description: "Detailed reference documentation for 2025-08-01-preview" ---- - diff --git a/docs/content/reference/resources/radius/radius.compute/_index.md b/docs/content/reference/resources/radius/radius.compute/_index.md deleted file mode 100644 index 0accb22bb..000000000 --- a/docs/content/reference/resources/radius/radius.compute/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: radius.compute" -linkTitle: "radius.compute" -description: "Detailed reference documentation for radius.compute" ---- - diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/_index.md deleted file mode 100644 index b3d055dde..000000000 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2025-08-01-preview" -linkTitle: "2025-08-01-preview" -description: "Detailed reference documentation for 2025-08-01-preview" ---- - diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md deleted file mode 100644 index ac0850131..000000000 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -type: docs -title: "Reference: radius.core/applications@2025-08-01-preview" -linkTitle: "applications" -description: "Detailed reference documentation for radius.core/applications@2025-08-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [ApplicationProperties](#applicationproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Radius.Core/applications' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### ApplicationProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | - -### ResourceStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | -| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | - -### EnvironmentCompute - -* **Discriminator**: kind - -#### Base Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | -| **resourceId** | string | The resource id of the compute resource for application environment. | - -#### AzureContainerInstanceCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | -| **resourceGroup** | string | The resource group to use for the environment. | - -#### KubernetesCompute - -##### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | -| **namespace** | string | The namespace to use for the environment.
_(Required)_ | - - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### OutputResource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **id** | string | The UCP resource ID of the underlying resource. | -| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | -| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | - -### RecipeStatus - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | -| **templateVersion** | string | TemplateVersion is the version number of the template. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md deleted file mode 100644 index 0e11a149f..000000000 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -type: docs -title: "Reference: radius.core/bicepconfigs@2025-08-01-preview" -linkTitle: "bicepconfigs" -description: "Detailed reference documentation for radius.core/bicepconfigs@2025-08-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [BicepConfigProperties](#bicepconfigproperties) | Bicep configuration properties.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | -| **registryAuthentications** | [BicepConfigPropertiesRegistryAuthentications](#bicepconfigpropertiesregistryauthentications) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Radius.Core/bicepConfigs' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### BicepConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | -| **registryAuthentications** | [BicepConfigPropertiesRegistryAuthentications](#bicepconfigpropertiesregistryauthentications) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path. | - -### BicepConfigPropertiesRegistryAuthentications - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [BicepRegistryAuthentication](#bicepregistryauthentication) - -### BicepRegistryAuthentication - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **authenticationMethod** | 'AwsIrsa' | 'AzureWI' | 'BasicAuth' | Supported authentication methods for private Bicep registries. | -| **awsIamRoleArn** | string | AWS IAM Role ARN for IRSA authentication. Required when authenticationMethod is 'AwsIrsa'. | -| **azureWiClientId** | string | Azure Workload Identity client ID. Required when authenticationMethod is 'AzureWI'. | -| **azureWiTenantId** | string | Azure Workload Identity tenant ID. Required when authenticationMethod is 'AzureWI'. | -| **basicAuthSecretId** | string | The ID of an Applications.Core/SecretStore resource containing username and password for BasicAuth. Required when authenticationMethod is 'BasicAuth'. | - -### BicepConfigPropertiesRegistryAuthentications - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [BicepRegistryAuthentication](#bicepregistryauthentication) - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | - -### TrackedResourceTags - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepsettings/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepsettings/index.md deleted file mode 100644 index becbd6314..000000000 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepsettings/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -type: docs -title: "Reference: radius.core/bicepsettings@2025-08-01-preview" -linkTitle: "bicepsettings" -description: "Detailed reference documentation for radius.core/bicepsettings@2025-08-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [BicepSettingsProperties](#bicepsettingsproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | -| **registryAuthentications** | [Record](#record) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Radius.Core/bicepSettings' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### BicepSettingsProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | -| **registryAuthentications** | [Record](#record) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [BicepRegistryAuthentication](#bicepregistryauthentication) - -### BicepRegistryAuthentication - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **authenticationMethod** | 'AwsIrsa' | 'AzureWI' | 'BasicAuth' | The authentication method to use. Supported values: BasicAuth, AzureWI, AwsIrsa. | -| **awsIamRoleArn** | string | AWS IAM Role ARN for IRSA authentication. Required when authenticationMethod is 'AwsIrsa'. | -| **azureWiClientId** | string | Azure Workload Identity client ID. Required when authenticationMethod is 'AzureWI'. | -| **azureWiTenantId** | string | Azure Workload Identity tenant ID. Required when authenticationMethod is 'AzureWI'. | -| **basicAuthSecretId** | string | The ID of a secret resource containing username and password for BasicAuth. Supported types: Radius.Security/secrets (recommended) or Applications.Core/secretStores. Required when authenticationMethod is 'BasicAuth'. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [BicepRegistryAuthentication](#bicepregistryauthentication) - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md deleted file mode 100644 index 5056899ea..000000000 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -type: docs -title: "Reference: radius.core/environments@2025-08-01-preview" -linkTitle: "environments" -description: "Detailed reference documentation for radius.core/environments@2025-08-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **bicepSettings** | string | Resource ID of a Radius.Core/bicepSettings resource providing Bicep recipe settings.
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [EnvironmentProperties](#environmentproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **providers** | [Providers](#providers) | Cloud provider configuration for the environment.
_(ReadOnly)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipePacks** | string[] | List of Recipe Pack resource IDs linked to this environment.
_(ReadOnly)_ | -| **recipeParameters** | [Record](#record) | Recipe specific parameters that apply to all resources of a given type in this environment.
_(ReadOnly)_ | -| **simulated** | bool | Simulated environment.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **terraformSettings** | string | Resource ID of a Radius.Core/terraformSettings resource providing Terraform recipe settings.
_(ReadOnly)_ | -| **type** | 'Radius.Core/environments' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### EnvironmentProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **bicepSettings** | string | Resource ID of a Radius.Core/bicepSettings resource providing Bicep recipe settings. | -| **providers** | [Providers](#providers) | Cloud provider configuration for the environment. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **recipePacks** | string[] | List of Recipe Pack resource IDs linked to this environment. | -| **recipeParameters** | [Record](#record) | Recipe specific parameters that apply to all resources of a given type in this environment. | -| **simulated** | bool | Simulated environment. | -| **terraformSettings** | string | Resource ID of a Radius.Core/terraformSettings resource providing Terraform recipe settings. | - -### Providers - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider configuration. | -| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider configuration. | -| **kubernetes** | [ProvidersKubernetes](#providerskubernetes) | The Kubernetes provider configuration. | - -### ProvidersAws - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **accountId** | string | AWS account ID for AWS resources to be deployed into.
_(Required)_ | -| **region** | string | AWS region for AWS resources to be deployed into.
_(Required)_ | - -### ProvidersAzure - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | External identity settings (moved from compute). | -| **resourceGroupName** | string | Optional resource group name. | -| **subscriptionId** | string | Azure subscription ID hosting deployed resources.
_(Required)_ | - -### IdentitySettings - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | -| **managedIdentity** | string[] | The list of user assigned managed identities | -| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | -| **resource** | string | The resource ID of the provisioned identity | - -### ProvidersKubernetes - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **namespace** | string | Kubernetes namespace to deploy workloads into.
_(Required)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeParameterValue](#recipeparametervalue) - -### RecipeParameterValue - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeParameterValue](#recipeparametervalue) - -### RecipeParameterValue - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md deleted file mode 100644 index c32badd05..000000000 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -type: docs -title: "Reference: radius.core/recipepacks@2025-08-01-preview" -linkTitle: "recipepacks" -description: "Detailed reference documentation for radius.core/recipepacks@2025-08-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [RecipePackProperties](#recipepackproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation
_(ReadOnly)_ | -| **recipes** | [Record](#record) | Map of resource types to their recipe configurations
_(ReadOnly)_ | -| **referencedBy** | string[] | List of environment IDs that reference this recipe pack
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **type** | 'Radius.Core/recipePacks' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### RecipePackProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation
_(ReadOnly)_ | -| **recipes** | [Record](#record) | Map of resource types to their recipe configurations
_(Required)_ | -| **referencedBy** | string[] | List of environment IDs that reference this recipe pack
_(ReadOnly)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeDefinition](#recipedefinition) - -### RecipeDefinition - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **kind** | 'bicep' | 'terraform' | The type of recipe (e.g., Terraform, Bicep)
_(Required)_ | -| **outputs** | [Record](#record) | Map of resource type property names to module output names. Used for recipes that point directly at a Bicep or Terraform module to map the module's outputs onto the resource's properties. | -| **parameters** | [Record](#record) | Parameters to pass to the recipe | -| **plainHttp** | bool | Connect to the source using HTTP (not HTTPS). This should be used when the source is known not to support HTTPS, for example in a locally hosted registry for Bicep recipes. Defaults to false (use HTTPS/TLS) | -| **source** | string | The source of the recipe. For Bicep recipes this is the OCI registry reference. For Terraform recipes this is the module source.
_(Required)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: any - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [RecipeDefinition](#recipedefinition) - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md deleted file mode 100644 index 1798e5d0e..000000000 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -type: docs -title: "Reference: radius.core/terraformconfigs@2025-08-01-preview" -linkTitle: "terraformconfigs" -description: "Detailed reference documentation for radius.core/terraformconfigs@2025-08-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **env** | [TerraformConfigPropertiesEnv](#terraformconfigpropertiesenv) | Environment variables injected during Terraform recipe execution.
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [TerraformConfigProperties](#terraformconfigproperties) | Terraform configuration properties.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file (.terraformrc) settings. See https://developer.hashicorp.com/terraform/cli/config for details.
_(ReadOnly)_ | -| **type** | 'Radius.Core/terraformConfigs' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### TerraformConfigPropertiesEnv - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### TerraformConfigProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **env** | [TerraformConfigPropertiesEnv](#terraformconfigpropertiesenv) | Environment variables injected during Terraform recipe execution. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | -| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file (.terraformrc) settings. See https://developer.hashicorp.com/terraform/cli/config for details. | - -### TerraformConfigPropertiesEnv - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### TerraformrcConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **credentials** | [TerraformrcConfigCredentials](#terraformrcconfigcredentials) | Credentials for authenticating to private Terraform registries (HTTP-based, e.g. app.terraform.io). Map of registry hostname to credential configuration. Rendered as native `credentials "hostname" {}` blocks in the generated .terraformrc. Note: this is for Terraform CLI registry auth (HTTP), not for Git-based module sources; Git auth is a separate mechanism. | -| **providerInstallation** | [TerraformProviderInstallation](#terraformproviderinstallation) | Provider installation configuration for Terraform CLI. | - -### TerraformrcConfigCredentials - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [TerraformCredentialConfig](#terraformcredentialconfig) - -### TerraformCredentialConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secret** | string | The ID of an Applications.Core/SecretStore resource containing the authentication token. The secret store must have a secret named 'token'. | - -### TerraformProviderInstallation - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **direct** | [TerraformProviderDirect](#terraformproviderdirect) | Direct provider installation configuration. | -| **networkMirror** | [TerraformProviderMirror](#terraformprovidermirror) | Network mirror configuration for Terraform providers. | - -### TerraformProviderDirect - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **exclude** | string[] | Provider address patterns to exclude from direct installation. | -| **include** | string[] | Provider address patterns to include for direct installation. | - -### TerraformProviderMirror - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **exclude** | string[] | Provider address patterns to exclude from this mirror. | -| **include** | string[] | Provider address patterns to include from this mirror. | -| **url** | string | The URL of the provider mirror. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | - -### TrackedResourceTags - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformsettings/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformsettings/index.md deleted file mode 100644 index 8e180e31c..000000000 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformsettings/index.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -type: docs -title: "Reference: radius.core/terraformsettings@2025-08-01-preview" -linkTitle: "terraformsettings" -description: "Detailed reference documentation for radius.core/terraformsettings@2025-08-01-preview" ---- - -{{< schemaExample >}} - -## Schema - -### Top-Level Resource - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **env** | [Record](#record) | Environment variables injected during Terraform recipe execution.
_(ReadOnly)_ | -| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **location** | string | The geo-location where the resource lives | -| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [TerraformSettingsProperties](#terraformsettingsproperties) | The resource-specific properties for this resource.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | -| **tags** | [Record](#record) | Resource tags. | -| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file settings. Maps directly to the Terraform CLI configuration file (.terraformrc).
_(ReadOnly)_ | -| **type** | 'Radius.Core/terraformSettings' | The resource type
_(ReadOnly, DeployTimeConstant)_ | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### TerraformSettingsProperties - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **env** | [Record](#record) | Environment variables injected during Terraform recipe execution. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | -| **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | -| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file settings. Maps directly to the Terraform CLI configuration file (.terraformrc). | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - -### TerraformrcConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **credentials** | [Record](#record) | Credentials for authenticating to private Terraform registries (HTTP-based, e.g. app.terraform.io). Map of registry hostname to credential configuration. Rendered as native `credentials "hostname" {}` blocks in the generated .terraformrc. Note: this is for Terraform CLI registry auth (HTTP), not for Git-based module sources; Git auth is a separate mechanism. | -| **providerInstallation** | [TerraformProviderInstallation](#terraformproviderinstallation) | Provider installation configuration. Specifies the location of providers via network mirrors or direct downloads. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [TerraformCredentialConfig](#terraformcredentialconfig) - -### TerraformCredentialConfig - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **secret** | string | The ID of a secret resource containing the authentication token. Supported types: Radius.Security/secrets (recommended) or Applications.Core/secretStores. The secret must have a key named 'token'. | - -### TerraformProviderInstallation - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **direct** | [TerraformProviderDirect](#terraformproviderdirect) | Direct provider installation configuration. | -| **networkMirror** | [TerraformProviderMirror](#terraformprovidermirror) | Network mirror configuration for downloading providers. | - -### TerraformProviderDirect - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **exclude** | string[] | Provider address patterns to exclude from direct installation. | -| **include** | string[] | Provider address patterns to include for direct installation. | - -### TerraformProviderMirror - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **exclude** | string[] | Provider address patterns to exclude from this mirror. | -| **include** | string[] | Provider address patterns to include from this mirror. | -| **url** | string | The URL of the provider mirror. | - -### SystemData - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **createdAt** | string | The timestamp of resource creation (UTC). | -| **createdBy** | string | The identity that created the resource. | -| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | -| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | -| **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | - -### Record - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: string - diff --git a/docs/content/reference/resources/radius/radius.core/_index.md b/docs/content/reference/resources/radius/radius.core/_index.md deleted file mode 100644 index 059f40dea..000000000 --- a/docs/content/reference/resources/radius/radius.core/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: radius.core" -linkTitle: "radius.core" -description: "Detailed reference documentation for radius.core" ---- - diff --git a/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/_index.md deleted file mode 100644 index b3d055dde..000000000 --- a/docs/content/reference/resources/radius/radius.data/2025-08-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2025-08-01-preview" -linkTitle: "2025-08-01-preview" -description: "Detailed reference documentation for 2025-08-01-preview" ---- - diff --git a/docs/content/reference/resources/radius/radius.data/_index.md b/docs/content/reference/resources/radius/radius.data/_index.md deleted file mode 100644 index 69f6cd213..000000000 --- a/docs/content/reference/resources/radius/radius.data/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: radius.data" -linkTitle: "radius.data" -description: "Detailed reference documentation for radius.data" ---- - diff --git a/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/_index.md deleted file mode 100644 index b3d055dde..000000000 --- a/docs/content/reference/resources/radius/radius.messaging/2025-08-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2025-08-01-preview" -linkTitle: "2025-08-01-preview" -description: "Detailed reference documentation for 2025-08-01-preview" ---- - diff --git a/docs/content/reference/resources/radius/radius.messaging/_index.md b/docs/content/reference/resources/radius/radius.messaging/_index.md deleted file mode 100644 index e5cd1f8e1..000000000 --- a/docs/content/reference/resources/radius/radius.messaging/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: radius.messaging" -linkTitle: "radius.messaging" -description: "Detailed reference documentation for radius.messaging" ---- - diff --git a/docs/content/reference/resources/radius/radius.security/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius/radius.security/2025-08-01-preview/_index.md deleted file mode 100644 index b3d055dde..000000000 --- a/docs/content/reference/resources/radius/radius.security/2025-08-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2025-08-01-preview" -linkTitle: "2025-08-01-preview" -description: "Detailed reference documentation for 2025-08-01-preview" ---- - diff --git a/docs/content/reference/resources/radius/radius.security/_index.md b/docs/content/reference/resources/radius/radius.security/_index.md deleted file mode 100644 index 9ef56b06f..000000000 --- a/docs/content/reference/resources/radius/radius.security/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: radius.security" -linkTitle: "radius.security" -description: "Detailed reference documentation for radius.security" ---- - diff --git a/docs/content/reference/resources/radius/radius.storage/2025-08-01-preview/_index.md b/docs/content/reference/resources/radius/radius.storage/2025-08-01-preview/_index.md deleted file mode 100644 index b3d055dde..000000000 --- a/docs/content/reference/resources/radius/radius.storage/2025-08-01-preview/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: 2025-08-01-preview" -linkTitle: "2025-08-01-preview" -description: "Detailed reference documentation for 2025-08-01-preview" ---- - diff --git a/docs/content/reference/resources/radius/radius.storage/_index.md b/docs/content/reference/resources/radius/radius.storage/_index.md deleted file mode 100644 index f8c53c07d..000000000 --- a/docs/content/reference/resources/radius/radius.storage/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Reference: radius.storage" -linkTitle: "radius.storage" -description: "Detailed reference documentation for radius.storage" ---- - diff --git a/docs/content/reference/samples/_index.md b/docs/content/reference/samples/_index.md deleted file mode 100644 index 7746ff970..000000000 --- a/docs/content/reference/samples/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Samples" -linkTitle: "Samples" -description: "Reference samples" -weight: 400 ---- \ No newline at end of file diff --git a/docs/content/reference/samples/helm/demo-screenshot.png b/docs/content/reference/samples/helm/demo-screenshot.png deleted file mode 100644 index 0d9f25d79..000000000 Binary files a/docs/content/reference/samples/helm/demo-screenshot.png and /dev/null differ diff --git a/docs/content/reference/samples/helm/demo-with-redis-screenshot.png b/docs/content/reference/samples/helm/demo-with-redis-screenshot.png deleted file mode 100644 index 77caa8eac..000000000 Binary files a/docs/content/reference/samples/helm/demo-with-redis-screenshot.png and /dev/null differ diff --git a/docs/content/reference/samples/helm/demo-with-todolist.png b/docs/content/reference/samples/helm/demo-with-todolist.png deleted file mode 100644 index 6bab2cb7d..000000000 Binary files a/docs/content/reference/samples/helm/demo-with-todolist.png and /dev/null differ diff --git a/docs/content/reference/samples/helm/diagram.png b/docs/content/reference/samples/helm/diagram.png deleted file mode 100644 index 8c65eb5ef..000000000 Binary files a/docs/content/reference/samples/helm/diagram.png and /dev/null differ diff --git a/docs/content/reference/samples/helm/index.md b/docs/content/reference/samples/helm/index.md deleted file mode 100644 index beef78ea8..000000000 --- a/docs/content/reference/samples/helm/index.md +++ /dev/null @@ -1,647 +0,0 @@ ---- -type: docs -title: "Tutorial: Use Helm to run your first app" -linkTitle: "Run app using Helm" -weight: 200 -description: "Take a tour of Radius by updating an existing Helm chart to add Radius support." -categories: "Tutorial" -tags : ["kubernetes", "helm"] ---- - -This tutorial will teach you the following about Radius: - -* How to use update a Helm chart to include its resources in a Radius application -* How to use features like Recipes and Connections within Kubernetes YAML or Helm - -Diagram of the application and its resources - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [Helm](https://helm.sh/docs/intro/install/) -- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) - -## Step 1. Clone and open the sample code - -{{< tabs "Codespace" "Local machine" >}} - -{{% codetab %}} - -It's easy and free to get up and running with a Radius Codespace in GitHub. Spin up a Radius environment in seconds with the following link: - -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/radius-project/samples) - -Once launched you should already have the application cloned locally. Use the terminal to navigate to the `./demo/` directory: - -```bash -cd ./samples/demo -``` -{{% /codetab %}} - -{{% codetab %}} -Use the terminal to clone the `samples` repository locally and navigate to the `./samples/demo` directory: - -```bash -git clone https://github.com/radius-project/samples.git -cd ./samples/samples/demo -``` -{{% /codetab %}} - -{{< /tabs >}} - - -## Step 2. Initialize Radius - -Initialize Radius. For this example, answer **NO** when asked whether to set up an application: - -> Select 'No' when prompted to create an application. - -```bash -rad init -``` - -## Step 3. Understand and deploy the application - -1. Navigate to the `./Chart` folder and browse its contents. This contains a Helm chart for the application that you will modify. - - Here are the contents of `./demo/Chart/templates/app.yaml`. This file is part of the Helm chart, and describes the container used for this tutorial: - - ```yaml - apiVersion: apps/v1 - kind: Deployment - metadata: - name: webapp - namespace: {{ .Release.Namespace }} - spec: - selector: - matchLabels: - app: webapp - template: - metadata: - labels: - app: webapp - spec: - containers: - - name: webapp - image: {{ .Values.image.repository }}:{{ .Values.image.tag }} - env: - - name: CONNECTION_REDIS_URL - valueFrom: - secretKeyRef: - name: redis-secret - key: url - ports: - - containerPort: 3000 - ``` - - The container that you will be working with is a ToDo application that uses Redis as a database. - - - The container is configured to listen on port 3000. - - The container will use the environment variable `CONNECTION_REDIS_URL` to connect to Redis. - - This `CONNECTION_REDIS_URL` environment variable is populated by a Kubernetes Secret. - - You can deploy this application for the first time by following these steps: - - - Create the Kubernetes namespace `demo` - - Create the Kubernetes Secret `redis-secret` containing the Redis URL. - - Install the Helm chart. - - {{< alert title="πŸ’‘ Redis" color="info" >}} For now you're not going to actually deploy Redis and the URL in this step is fake. You will deploy Redis using a Recipe later in the tutorial that will replace the fake URL contained within `redis-secret` with an actual container and URL.{{< /alert >}} - -1. Complete these steps by running the following commands: - - ```bash - kubectl create namespace demo - kubectl create secret generic --namespace demo --from-literal=url=redis://fake-server redis-secret - helm upgrade demo ./Chart -n demo --install - ``` - - The output should look similar to the following: - - ``` - > kubectl create namespace demo - namespace/demo created - - > kubectl create secret generic --namespace demo --from-literal=url=redis://fake-server redis-secret - secret/redis-secret created - - > helm upgrade demo ./Chart -n demo --install - Release "demo" does not exist. Installing it now. - NAME: demo - LAST DEPLOYED: Wed Sep 13 01:05:19 2023 - NAMESPACE: demo - STATUS: deployed - REVISION: 1 - TEST SUITE: None - ``` - - {{< alert title="⚠️ Chart Directory" color="warning" >}} If you see an error message like **Error: path "./Chart" not found** then you are in the wrong directory. Make sure your terminal is in the `./demo` directory of the `samples` repository.{{< /alert >}} - -1. Run the following command to check if everything is running: - - ```bash - kubectl get all -n demo - ``` - - The output should look similar to the following: - - ``` - > kubectl get all -n demo - NAME READY STATUS RESTARTS AGE - pod/webapp-79d5dfb99-vhj9g 1/1 Running 0 2m48s - - NAME READY UP-TO-DATE AVAILABLE AGE - deployment.apps/webapp 1/1 1 1 2m49s - - NAME DESIRED CURRENT READY AGE - replicaset.apps/webapp-79d5dfb99 1 1 1 2m49s - ``` - - > The generated names and ages of the objects will be different in your output. Make sure you see the status of `Running` for the `pod/webapp-...` entry. If the status is not `Running`, try repeating the `kubectl get all -n demo` after waiting. - - At this point you've deployed the application but you have not actually used Radius yet. You will start doing that in the next step, as well as set up and use Redis. - -The steps so far are similar to how many applications are managed today: - -- Dependencies like Redis are provisioned manually and separately from application deployment. -- Connection information like passwords and addresses is manually stored in secret stores. -- Applications access the connection information from those secret stores when they are deployed. - -Over the next few steps you will update this application to use Radius so that: - -- βœ… Dependencies like Redis are provisioned on-demand when they are needed. -- βœ… Connection information is managed automatically, secret stores are an implementation detail. -- βœ… Applications have a documented relationship with the dependencies they connect to. - -From here you will go through a series of steps to incrementally add more Radius features to the application. - -## Step 4. Add Radius - -1. Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. You will make some edits to this file to enable Radius. - - Add the `annotations` property to `metadata`, and then add the `radapp.io/enabled: 'true'` annotation. The `'true'` must be surrounded in quotes. - - The example below shows the updated `metadata` section after making the changes. - - ```yaml - apiVersion: apps/v1 - kind: Deployment - metadata: - name: webapp - namespace: {{ .Release.Namespace }} - # Add the following two lines - annotations: - radapp.io/enabled: 'true' - radapp.io/environment: '{{ .Values.environment }}' - spec: - ... - ``` - - Adding the `radapp.io/enabled: 'true'` annotation enables Radius for the deployment. The `radapp.io/environment` annotation is optional and is used to set the environment for the application. If not specified, Radius will use the default environment. - -1. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, we only need to run the `helm` command. - - ```bash - helm upgrade demo ./Chart -n demo --install - ``` - - The output should look like: - - ``` - > helm upgrade demo ./Chart -n demo --install - Release "demo" has been upgraded. Happy Helming! - NAME: demo - LAST DEPLOYED: Wed Sep 13 01:31:58 2023 - NAMESPACE: demo - STATUS: deployed - REVISION: 2 - TEST SUITE: None - ``` - - You should confirm that your output contains `REVISION: 2`, that means that the changes were applied. - -1. Run the following command to confirm that everything is running: - - ```bash - kubectl get all -n demo - ``` - - The output should look similar to the following: - - ``` - > kubectl get all -n demo - NAME READY STATUS RESTARTS AGE - pod/webapp-79d5dfb99-mv6q9 1/1 Running 0 10m - - NAME READY UP-TO-DATE AVAILABLE AGE - deployment.apps/webapp 1/1 1 1 10m - - NAME DESIRED CURRENT READY AGE - replicaset.apps/webapp-79d5dfb99 1 1 1 10m - ``` - - Notice that the `AGE` of `pod/webapp-...` reflects the time of your **first** deployment. Enabling Radius for an application does not change any of its behaviors, so Kubernetes did not need to restart the container. - -1. Now that Radius has been enabled, run this command to display the state of the Radius application: - - ```bash - rad app graph -a demo -g default-demo - ``` - where `-a demo` specifies the application name and `-g default-demo` specifies the resource group name. [Resource groups]({{< ref "guides/operations/groups/overview" >}}) are a way to organize resources in Radius. - - The output should look like this: - - ``` - > rad app graph -a demo -g default-demo - Displaying application: demo - - Name: webapp (Applications.Core/containers) - Connections: (none) - Resources: - webapp (kubernetes: apps/Deployment) - ``` - - This means that Radius has found the Kubernetes `Deployment` running your container and cataloged it as part of the application. - - {{< alert title="πŸ’‘ Application Name" color="info" >}}Radius will use the Kubernetes namespace as the application name by default. {{< /alert >}} - -## Step 5. Add Recipe - -This step will add a database (Redis Cache) to the application. - -You can create a Redis Cache using [Recipes]({{< ref "concepts/recipes" >}}) provided by Radius. The Radius community provides [Recipes](https://github.com/radius-project/recipes) for running commonly used application dependencies, including Redis. - -In this step you will: - -- Add Redis to the application using a Recipe. -- Update the Kubernetes secret with the connection information from Redis. - -1. First, check recipes installed in your environment by running: - - ```bash - rad recipe list - ``` - - You will see output like this: - - ``` - NAME TYPE TEMPLATE KIND TEMPLATE VERSION TEMPLATE - default Applications.Datastores/sqlDatabases bicep radius.ghcr.io/recipes/local-dev/sqldatabases:latest - default Applications.Messaging/rabbitMQQueues bicep radius.ghcr.io/recipes/local-dev/rabbitmqqueues:latest - default Applications.Dapr/pubSubBrokers bicep radius.ghcr.io/recipes/local-dev/pubsubbrokers:latest - default Applications.Dapr/secretStores bicep radius.ghcr.io/recipes/local-dev/secretstores:latest - default Applications.Dapr/stateStores bicep radius.ghcr.io/recipes/local-dev/statestores:latest - default Applications.Datastores/mongoDatabases bicep radius.ghcr.io/recipes/local-dev/mongodatabases:latest - default Applications.Datastores/redisCaches bicep radius.ghcr.io/recipes/local-dev/rediscaches:latest - ``` - - The recipe for `Applications.Datastores/redisCaches` is what you will use in this example. - - {{< alert title="πŸ’‘ Recipes" color="info" >}} - Radius includes Recipes for local development when you use `rad init`. These [**local-dev**](https://github.com/radius-project/recipes/tree/main/local-dev) Recipes run popular OSS technologies as containerized infrastructure without requiring a cloud account. - - In a production environment you can substitute recipes that will create cloud or on-premises dependencies instead. - {{< /alert >}} - -1. Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. At the bottom of the file add the following text, including the `---`: - - ```yaml - --- - apiVersion: radapp.io/v1alpha3 - kind: Recipe - metadata: - name: db - namespace: {{ .Release.Namespace }} - spec: - environment: '{{ .Values.environment }}' - type: Applications.Datastores/redisCaches - secretName: redis-secret - ``` - - Defining a `Recipe` object in Kubernetes will use a Radius Recipe to create dependencies for your application: - - - The `.spec.type` field defines the type of resource to create. `Applications.Datastores/redisCaches` is the type for a Redis Cache. - - The `.spec.secretName` field tells Radius where to store connection information. This is optional, and should be used to interoperate with other Kubernetes technologies that read from secrets. This tutorial example uses the secret to populate an environment variable. - -1. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, you only need to run the `helm` command. - - ```bash - helm upgrade demo ./Chart -n demo --install - ``` - - The output should look like: - - ``` - > helm upgrade demo ./Chart -n demo --install - Release "demo" has been upgraded. Happy Helming! - NAME: demo - LAST DEPLOYED: Wed Sep 13 01:44:04 2023 - NAMESPACE: demo - STATUS: deployed - REVISION: 3 - TEST SUITE: None - ``` - - This time you should see `REVISION: 3`. - -1. Now that you are using a Recipe, you should see more resources running in Kubernetes. Run the following command: - - ```bash - kubectl get all -n demo - ``` - - The output should look similar to the following: - - ``` - > kubectl get all -n demo - - pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 51s - pod/webapp-79d5dfb99-f6xgj 1/1 Running 0 52s - - NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - service/redis-r5tcrra3d7uh6 ClusterIP 10.43.104.63 6379/TCP 51s - - NAME READY UP-TO-DATE AVAILABLE AGE - deployment.apps/redis-r5tcrra3d7uh6 1/1 1 1 51s - deployment.apps/webapp 1/1 1 1 52s - - NAME DESIRED CURRENT READY AGE - replicaset.apps/redis-r5tcrra3d7uh6-7bcd8b8d8d 1 1 1 51s - replicaset.apps/webapp-79d5dfb99 1 1 1 52s - - NAME TYPE SECRET STATUS - recipe.radapp.io/db Applications.Datastores/redisCaches redis-secret Ready - ``` - - Look at the status of the `recipe.radapp.io/db` resource. If the status is not `Ready`, then try running the command again after a delay. The status should show as `Ready` when the Recipe has fully-deployed. You can also see additional resources starting with `redis-`. These were created by the Recipe. - - {{< alert title="⚠️ Missing resources" color="warning" >}} If you do not see the additional resources starting with `redis-` then it's likely they are in a different Kubernetes namespace. Run `kubectl get all -A` to see everything.{{< /alert >}} - -1. Now that you have added a Recipe, run this command to display the state of the Radius application: - - ```bash - rad app graph -a demo -g default-demo - ``` - - The output should look like this: - - ``` - > rad app graph -a demo -g default-demo - Displaying application: demo - - Name: webapp (Applications.Core/containers) - Connections: (none) - Resources: - webapp (kubernetes: apps/Deployment) - - Name: db (Applications.Datastores/redisCaches) - Connections: (none) - Resources: - redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) - redis-r5tcrra3d7uh6 (kubernetes: core/Service) - ``` - - `rad app graph` shows the **Application Graph** of the application. This includes: - - - Entries for each major resource: `webapp` is an `Applications.Core/containers` and `db` is an `Applications.Datastores/redisCaches`. - - Connections between resources: (none yet, you will add this next). - - Resources that were created: see the Kubernetes `Deployment` listed for `webapp` and the Kubernetes `Deployment` and `Service` listed for `db`. - - The Redis Cache created by the recipe is visible as part of the application. You can also see the `Resources` created in Kubernetes that make up the Redis Cache. In a previous step you saw these listed by `kubectl`. Since Radius deployed the Recipe, it knows that these resources *logically* are part of the Redis Cache in the application. - -1. You can also see the contents of `redis-secret` as created by Radius. Run the following command: - - ```bash - kubectl get secret -n demo redis-secret -o yaml - ``` - - The output should look like the following: - - ``` - >kubectl get secret -n demo redis-secret -o yaml - apiVersion: v1 - data: - connectionString: cmVkaXMtcjV0Y3JyYTNkN3VoNi5kZW1vLnN2Yy5jbHVzdGVyLmxvY2FsOjYzNzksYWJvcnRDb25uZWN0PUZhbHNl - host: cmVkaXMtcjV0Y3JyYTNkN3VoNi5kZW1vLnN2Yy5jbHVzdGVyLmxvY2Fs - password: "" - port: NjM3OQ== - tls: ZmFsc2U= - url: cmVkaXM6Ly9yZWRpcy1yNXRjcnJhM2Q3dWg2LmRlbW8uc3ZjLmNsdXN0ZXIubG9jYWw6NjM3OS8wPw== - username: "" - kind: Secret - metadata: - creationTimestamp: "2023-09-13T01:49:36Z" - name: redis-secret - namespace: demo - ownerReferences: - - apiVersion: radapp.io/v1alpha3 - blockOwnerDeletion: true - controller: true - kind: Recipe - name: db - uid: d40567a1-cd52-4984-8321-6cb8bea5f798 - resourceVersion: "3672" - uid: b1613fb0-09e6-4f76-8685-02f458e173b9 - type: Opaque - ``` - - The actual values like `connectionString` are Base64 encoded in this display. The `url` value in this secret is being used by the container to connect to the Redis Cache. For each type of Recipe, Radius stores the most-commonly used connection information for the convenience of application developers. - -## Step 6. Add Connection - -At this point you have added Radius to your existing container and used a Recipe to create a Redis Cache. In this step, you will use Radius Connections to inject settings into the container instead of explicitly managing a secret. - -Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. - -1. First, add another annotation. This time add the `radapp.io/connection-redis: 'db'` annotation, to `.metadata.annotations`. Order does not matter but indentation does. - - Here's the updated content of `metadata`: - - ```yaml - apiVersion: apps/v1 - kind: Deployment - metadata: - name: webapp - namespace: {{ .Release.Namespace }} - annotations: - radapp.io/enabled: 'true' - radapp.io/environment: '{{ .Values.environment }}' - radapp.io/connection-redis: 'db' - spec: - ... - ``` - - The `radapp.io/connection-` annotation defines a connection from the container to some other dependency. Each connection has: - - - A name: `redis` is the connection name this case. - - A source: `db` is the name of the Recipe you created earlier. - - Connections are named because you can define many of them. The connection name is used to generate environment variables that are unique to the connection. - - Since you're using a connection called `redis`, Radius will automatically define the `CONNECTION_REDIS_URL` environment variable. The prefix of `CONNECTION_REDIS_` will be combined with each of the settings that you could see in the `redis-secret` secret in the previous step. - -1. You can remove the manual definition of `CONNECTION_REDIS_URL` from `app.yaml` since Radius will provide it automatically. Find the `env` property and delete all of its contents. You can also remove `.spec.secretName` from the `Recipe`. - - The final contents of `app.yaml` should look like: - - ```yaml - apiVersion: apps/v1 - kind: Deployment - metadata: - name: webapp - namespace: {{ .Release.Namespace }} - annotations: - radapp.io/enabled: 'true' - radapp.io/environment: '{{ .Values.environment }}' - radapp.io/connection-redis: 'db' - spec: - selector: - matchLabels: - app: webapp - template: - metadata: - labels: - app: webapp - spec: - containers: - - name: webapp - image: {{ .Values.image.repository }}:{{ .Values.image.tag }} - ports: - - containerPort: 3000 - --- - apiVersion: radapp.io/v1alpha3 - kind: Recipe - metadata: - name: db - namespace: {{ .Release.Namespace }} - spec: - environment: '{{ .Values.environment }}' - type: Applications.Datastores/redisCaches - ``` - -1. Save the file after you have made the edits and deploy the application again using Helm. - - ```bash - helm upgrade demo ./Chart -n demo --install - ``` - - The output should look like: - - ``` - > helm upgrade demo ./Chart -n demo --install - Release "demo" has been upgraded. Happy Helming! - NAME: demo - LAST DEPLOYED: Wed Sep 13 02:09:41 2023 - NAMESPACE: demo - STATUS: deployed - REVISION: 4 - TEST SUITE: None - ``` - - This time you should see `REVISION: 4`. - - Check the status in Kubernetes again by running: - - ```bash - kubectl get all -n demo - ``` - - The output should look like: - - ``` - > 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 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 - ``` - - Depending on the timing you may see pods in the `Terminating` state. This is normal as old replicas take some time to shut down. - -1. Check the Radius status again. Now Radius is aware of the connection from `webapp->db`: - - ```bash - rad app graph -a demo -g default-demo - ``` - - The output should look like the example below: - - ``` - > rad app graph -a demo -g default-demo - Displaying application: demo - - Name: webapp (Applications.Core/containers) - Connections: - webapp -> db (Applications.Datastores/redisCaches) - Resources: - webapp (kubernetes: apps/Deployment) - - Name: db (Applications.Datastores/redisCaches) - Connections: - webapp (Applications.Core/containers) -> db - Resources: - redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) - redis-r5tcrra3d7uh6 (kubernetes: core/Service) - ``` - -## Step 7. Try it out - -In this step you can access the application and explore its features. Since the container is running inside Kubernetes, you need to run a port-forward to use it locally. - -1. Run the following command to start the port-forward: - - ```bash - kubectl port-forward -n demo deployment/webapp 3000 - ``` - - If you are inside Codespaces this will open a new browser tab that you can use to access the webapp. - - If you are not using Codespaces then open your browser and navigate to `http://localhost:3000` - - Screenshot of the demo container -

- - Congrats! You're running your first Radius app. - - You can use the homepage to view information about the container and its settings. - -1. Navigate to the ToDo List tab and test out the application. Using the ToDo page will update the saved state in Redis. - - Screenshot of the todolist -

- - When you're ready to move on to the next step, use `CTRL+C` to exit the command. - -## Cleanup and next steps - -To delete your app, run the following command: - -> This command also cleans up all the resources created by the Radius Recipe you deployed earlier. - -```bash -helm uninstall demo -n demo -``` - -In summary, this tutorial walked through a hands-on example to show you how-to: - -- Enable Radius for a Helm or Kubernetes-based application to catalog your assets. -- Use Recipes to create dependencies either for development or production use. -- Use Connections to automate the management of connection information. - -
-{{< button text="Next step: Try another tutorial" page="tutorials" >}} diff --git a/docs/content/reference/samples/tutorial-add-radius/guestbook-app.png b/docs/content/reference/samples/tutorial-add-radius/guestbook-app.png deleted file mode 100644 index f3c5c3938..000000000 Binary files a/docs/content/reference/samples/tutorial-add-radius/guestbook-app.png and /dev/null differ diff --git a/docs/content/reference/samples/tutorial-add-radius/guestbook-ui.png b/docs/content/reference/samples/tutorial-add-radius/guestbook-ui.png deleted file mode 100644 index c88e644cf..000000000 Binary files a/docs/content/reference/samples/tutorial-add-radius/guestbook-ui.png and /dev/null differ diff --git a/docs/content/reference/samples/tutorial-add-radius/index.md b/docs/content/reference/samples/tutorial-add-radius/index.md deleted file mode 100644 index c24f9ef67..000000000 --- a/docs/content/reference/samples/tutorial-add-radius/index.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -type: docs -title: "Tutorial: Add Radius to an existing application" -linkTitle: "Existing application" -description: "Learn how to incrementally add Radius to an existing application" -weight: 600 -slug: "add-radius" -categories: "Tutorial" -tags : ["kubernetes","kubectl"] ---- - -This tutorial will teach you about adding Radius to an existing application using the built-in Kubernetes integration functionality. You will learn how to: - -1. Deploy an existing Kubernetes application -1. Run and test the application -1. Add Radius to the deployed application -1. Confirm that Radius was added and can detect the application - -By the end of this tutorial, you will have deployed an existing Kubernetes application and then updated it to add Radius functionality without changing the application or its original Kubernetes configurations. - -## Prerequisites - -- [Kubernetes cluster]({{< ref "guides/operations/kubernetes/overview#supported-kubernetes-clusters" >}}) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- [rad CLI]({{< ref howto-rad-cli >}}) - -## Overview - -As a part of this tutorial you will deploy an existing containerized Guestbook application originally authored by the Kubernetes community for use in their own tutorials. You will then add Radius to the deployed application. To incrementally add Radius to an existing application, you will leverage the built-in Kubernetes integration functionality by adding an annotation to the application's Kubernetes deployment manifest. This approach is particularly useful for adding Radius capabilities to applications that are already deployed. - -The Guestbook application consists of a web front end along with primary and secondary Redis containers for storage, all deployed with Kubernetes. For more information about the application and access its source code, see the [Kubernetes tutorial](https://kubernetes.io/docs/tutorials/stateless-application/guestbook/) and their [examples repo](https://github.com/kubernetes/examples/tree/master/web/guestbook). - -Guestbook application architecture diagram - -## Step 1: Set up your environment - -1. Clone the Radius samples repo to your local machine: - - ```bash - git clone https://github.com/radius-project/samples.git - ``` - -1. Navigate to the `samples/kubernetes/guestbook` directory: - - ```bash - cd samples/kubernetes/guestbook - ``` - - > The `kubernetes/guestbook` directory contains the Kubernetes YAML manifest files for their Guestbook sample application, copied directly from the [Kubernetes examples repo](https://github.com/kubernetes/examples/tree/master/web/guestbook). - -1. Initialize Radius: - - Run this command to initialize Radius. For this example, answer **NO** when asked whether to set up an application: - - ```bash - rad init - ``` - - You should see output similar to: - - ``` - Initializing Radius... - βœ… Install Radius {{< param version >}} - - Kubernetes cluster: k3d-k3s-default - - Kubernetes namespace: radius-system - βœ… Create new environment default - - Kubernetes namespace: default - - Recipe pack: local-dev - βœ… Update local configuration - Initialization complete! Have a RAD time 😎 - ``` - -Step 2: Deploy and test the existing Guestbook application using `kubectl` - -1. Create a Kubernetes namespace called `demo`: - - ```bash - kubectl create namespace demo - ``` - -1. Create and deploy the Guestbook application to the `demo` namespace: - - ```bash - kubectl apply -n demo -f ./deploy - ``` - -1. Verify that the application successfully deployed: - - ```bash - kubectl get all -n demo - ``` - - You should see output similar to below, with 5 pods and 3 services successfully deployed as expected: - - ``` - NAME READY STATUS RESTARTS AGE - pod/redis-replica-787cd488b4-n7b4p 1/1 Running 0 10s - pod/redis-replica-787cd488b4-vf6fh 1/1 Running 0 10s - pod/frontend-77dfc58d7c-8zht6 1/1 Running 0 10s - pod/redis-master-7597b47b98-ddgq9 1/1 Running 0 10s - pod/frontend-77dfc58d7c-2gs2p 1/1 Running 0 10s - pod/frontend-77dfc58d7c-2qd22 1/1 Running 0 10s - - NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - service/frontend NodePort 10.43.49.106 80:30972/TCP 10s - service/redis-master ClusterIP 10.43.233.148 6379/TCP 10s - service/redis-replica ClusterIP 10.43.118.183 6379/TCP 10s - - NAME READY UP-TO-DATE AVAILABLE AGE - deployment.apps/redis-replica 2/2 2 2 10s - deployment.apps/redis-master 1/1 1 1 10s - deployment.apps/frontend 3/3 3 3 10s - - NAME DESIRED CURRENT READY AGE - replicaset.apps/redis-replica-787cd488b4 2 2 2 10s - replicaset.apps/redis-master-7597b47b98 1 1 1 10s - replicaset.apps/frontend-77dfc58d7c 3 3 3 10s - ``` - -1. Validate that the application is running as expected: - - Run this command to port forward the Guestbook application to port `8080` on your local machine: - - ```bash - kubectl port-forward -n demo svc/frontend 8080:80 - ``` - - Open a browser and navigate to [`http://localhost:8080`](http://localhost:8080). You should see the Guestbook application running: - - Guestbook application - - Terminate the port forwarding process by pressing `CTRL+C` in your terminal. - -1. Confirm that Radius has not yet been added: - - Run this command to view the state of your application using Radius: - - ```bash - rad app graph -a demo -g default-demo - ``` - - Since you have not yet added Radius to the application, the `rad` CLI will not recognize your `demo` application and you should see a message in the output similar to: - - ``` - Displaying application: demo - - (empty) - ``` - -## Step 3: Add Radius to the Guestbook application - -You will now add Radius to the Guestbook application's Kubernetes deployment manifests by making edits to the YAML files in the `deploy` directory. - -1. In each of the YAML files that contain a manifest for `Kind: Deployment`, add the `annotations` property to `metadata`, and then add the `radapp.io/enabled: 'true'` annotation. Note that the `'true'` must be surrounded in quotes. - - ```yaml - ... - metadata: - ... - annotations: - radapp.io/enabled: 'true' - ... - spec: - ... - ``` - - You should add the annotation to the following files: - - `deploy/frontend-deployment.yaml` - - `deploy/redis-master-deployment.yaml` - - `deploy/redis-replica-deployment.yaml`

- - > Note: Since Radius does not model Kubernetes Services, you do not need to add the annotation to the YAML files that contain a manifest for `Kind: Service` (e.g. `deploy/frontend-service.yaml`). - -
As an example, your `deploy/frontend-deployment.yaml` file should look like this: - - ```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 - ``` - -1. Save your changes to the YAML files. - -## Step 4: Deploy and test the updated Guestbook application using `kubectl` - -1. Run this command to deploy the updated Guestbook application to the `demo` namespace: - - ```bash - kubectl apply -n demo -f ./deploy - ``` - -1. Verify that the application successfully deployed: - - ```bash - kubectl get deployments -n demo - kubectl get services -n demo - ``` - - You should see output similar to below, with the same 3 deployments and 3 services running as expected. Notice that the AGE of each resource reflects the time of your first deployment. Enabling Radius for an application does not change any of its behaviors, so Kubernetes did not need to restart the containers. - - ``` - NAME READY UP-TO-DATE AVAILABLE AGE - redis-master 1/1 1 1 10m - redis-replica 2/2 2 2 10m - frontend 3/3 3 3 10m - NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - frontend NodePort 10.43.49.106 80:30972/TCP 10m - redis-master ClusterIP 10.43.233.148 6379/TCP 10m - redis-replica ClusterIP 10.43.118.183 6379/TCP 10m - ``` - -1. Validate that the application is running as expected: - - Once again, run this command to port forward the Guestbook application to port `8080` on your local machine: - - ```bash - kubectl port-forward -n demo svc/frontend 8080:80 - ``` - - Open a browser and navigate to [`http://localhost:8080`](http://localhost:8080). You should see the Guestbook application running: - - Guestbook application - - Terminate the port forwarding process by pressing `CTRL+C` in your terminal. - -## Step 5: Use Radius to display the state of your application - -Now that Radius has been enabled for your application, run this command again: - -```bash -rad app graph -a demo -g default-demo -``` - -You should see output containing information and status of your newly "radified" application, similar to: - -``` -Displaying application: demo - -Name: frontend (Applications.Core/containers) -Connections: (none) -Resources: - frontend (kubernetes: apps/Deployment) - -Name: redis-master (Applications.Core/containers) -Connections: (none) -Resources: - redis-master (kubernetes: apps/Deployment) - -Name: redis-replica (Applications.Core/containers) -Connections: (none) -Resources: - redis-replica (kubernetes: apps/Deployment) -``` - -This output shows that Radius has detected the three container resources in the Kubernetes application that you have just deployed. Note that since you have not used Radius to define any connections between the resources, the `Connections` field is empty. However, your application is now ready to be further modified using the Radius features that are now available to you, , such as [Connections]({{< ref "guides/author-apps/containers/overview#connections" >}}), [Recipes]({{< ref "concepts/recipes" >}}), and more. - -## Step 6: Clean up - -1. Run the following command to delete all Pods, Deployments, and Services in the `demo` namespace: - - ```bash - kubectl delete -n demo -f ./deploy - ``` - - The output should look similar to: - - ``` - deployment.apps "frontend" deleted - service "frontend" deleted - deployment.apps "redis-master" deleted - service "redis-master" deleted - deployment.apps "redis-replica" deleted - service "redis-replica" deleted - ``` - -1. Run the following command to delete the `demo` namespace: - - ```bash - kubectl delete namespace demo - ``` - - The output should look similar to: - - ``` - namespace "demo" deleted - ``` - -## Next steps - -- To learn more about authoring Radius applications, visit the [Authoring applications guide]({{< ref "guides/author-apps" >}}) -- To learn more about deploying applications using Radius, visit the [Deploying applications guide]({{< ref "guides/deploy-apps" >}}) -- To learn more about using the [Radius Connections]({{< ref "guides/author-apps/containers/overview#connections" >}}) annotations to connect your containers and resources, visit the [Radius Helm tutorial]({{< ref "reference/samples/helm#step-6-add-connection" >}}) -- To learn more about Radius Recipes, visit the [Recipes guide]({{< ref "guides/recipes" >}}) diff --git a/docs/content/reference/samples/tutorial-dapr/frontend.png b/docs/content/reference/samples/tutorial-dapr/frontend.png deleted file mode 100644 index 4fb0d3d4f..000000000 Binary files a/docs/content/reference/samples/tutorial-dapr/frontend.png and /dev/null differ diff --git a/docs/content/reference/samples/tutorial-dapr/icon.png b/docs/content/reference/samples/tutorial-dapr/icon.png deleted file mode 100644 index 8d5dfe247..000000000 Binary files a/docs/content/reference/samples/tutorial-dapr/icon.png and /dev/null differ diff --git a/docs/content/reference/samples/tutorial-dapr/index.md b/docs/content/reference/samples/tutorial-dapr/index.md deleted file mode 100644 index 88b63b1c9..000000000 --- a/docs/content/reference/samples/tutorial-dapr/index.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -type: docs -title: "Tutorial: Dapr Microservices" -linkTitle: "Dapr microservices" -description: "Learn Radius by authoring templates and deploying a Dapr application" -weight: 300 -slug: "dapr" -categories: "Tutorial" -tags : ["Dapr"] ---- - -This tutorial will teach you the following about Dapr: - -- How to use Radius to deploy a Dapr microservices sample application for an online shop -- How [Dapr and Radius]({{< ref "guides/author-apps/dapr" >}}) seamlessly work together - -For more details on the app and access to the source code, visit the `samples/dapr` directory in the [samples repo](https://github.com/radius-project/samples). - -## Prerequisites - -- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [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/) - -## Step 1: Initialize a Radius Environment - -1. Begin in a new directory for your application: - - ```bash - mkdir dapr - cd dapr - ``` - -1. Initialize a new dev environment: - - *Select 'Yes' when prompted to create an application.* - - ```bash - rad init - ``` - -## Step 2: Define the application, `backend` container, and Dapr state store - -Begin by creating a new file named `dapr.bicep` with a Radius Application that consists of a `backend` container and Dapr state store with Redis: - -{{< rad file="snippets/dapr.bicep" embed=true marker="//BACKEND" >}} - -## Step 3: Deploy the `backend` application - -1. Deploy the application's `backend` container and Dapr state store: - - ```sh - rad run dapr.bicep - ``` - -1. You can confirm all the resources were deployed by looking for `dapr`, `backend`, and `statestore` resources in the console logs: - ``` - Deployment Complete - - Resources: - dapr Applications.Core/applications - backend Applications.Core/containers - statestore Applications.Dapr/stateStores - ``` - -1. The `rad run` command automatically sets up port forwarding. Visit the the URL [http://localhost:3000/order](http://localhost:3000/order) in your browser. You should see the following message, which confirms the container is able to communicate with the state store: - - ``` - {"message":"no orders yet"} - ``` - -1. Press CTRL+C to terminate the port-forward. - -1. A [local-dev Recipe]({{< ref "concepts/recipes" >}}) was run during application deployment to automatically create a lightweight Redis container plus a Dapr component configuration. Confirm that the Dapr Redis statestore was successfully created: - - ```sh - dapr components -k -A - ``` - - You should see the following output: - - ``` - NAMESPACE NAME TYPE VERSION SCOPES CREATED AGE - default-dapr statestore state.redis v1 2023-07-21 16:04.27 21m - ``` - -## Step 4: Define the `frontend` container - -Add a `frontend` [container]({{< ref "guides/author-apps/containers" >}}) which will serve as the application's user interface. - -{{< rad file="snippets/dapr.bicep" embed=true marker="//FRONTEND" >}} - -## Step 5. Deploy and run the `frontend` application - -1. Use Radius to deploy and run the application with a single command: - - ```sh - rad run dapr.bicep - ``` - -1. Your console should output a series of deployment logs, which you may check to confirm the `frontend` container was successfully deployed: - - ``` - Deployment Complete - - Resources: - dapr Applications.Core/applications - backend Applications.Core/containers - frontend Applications.Core/containers - statestore Applications.Dapr/stateStores - ``` - -## Step 6. Test your application - -In your browser, navigate to the endpoint (e.g. [http://localhost:8080](http://localhost:8080)) to view and interact with your application: - - {{< image src="frontend.png" alt="Screenshot of frontend application" width=500 >}} - -## Cleanup - -1. Press `CTRL`+`C` to terminate the log console - -1. Run the following command to cleanup your Radius Application, containers, and Dapr statestore. The Recipe resources (_Redis container and Dapr component_) are also automatically cleaned up. - - ```bash - rad app delete - ``` - -## Next steps - -- Related links for Dapr: - - [Dapr documentation](https://docs.dapr.io/) - - [Dapr quickstarts](https://github.com/dapr/quickstarts/tree/v1.0.0/hello-world) -- If you'd like to try another tutorial with your existing environment, go back to the [Radius tutorials]({{< ref tutorials >}}) page. diff --git a/docs/content/reference/samples/tutorial-dapr/snippets/dapr.bicep b/docs/content/reference/samples/tutorial-dapr/snippets/dapr.bicep deleted file mode 100644 index c3ee94432..000000000 --- a/docs/content/reference/samples/tutorial-dapr/snippets/dapr.bicep +++ /dev/null @@ -1,85 +0,0 @@ -//BACKEND -extension radius - -@description('Specifies the environment for resources.') -param environment string - -@description('The ID of your Radius Application. Automatically injected by the rad CLI.') -param application string - -// The backend container that is connected to the Dapr state store -resource backend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'backend' - properties: { - application: application - container: { - // This image is where the app's backend code lives - image: 'ghcr.io/radius-project/samples/dapr-backend:latest' - ports: { - orders: { - containerPort: 3000 - } - } - } - connections: { - orders: { - source: stateStore.id - } - } - extensions: [ - { - kind: 'daprSidecar' - appId: 'backend' - appPort: 3000 - } - ] - } -} - -// The Dapr state store that is connected to the backend container -resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { - name: 'statestore' - properties: { - // Provision Redis Dapr state store automatically via the default Radius Recipe - environment: environment - application: application - } -} -//BACKEND - -//FRONTEND -// The frontend container that serves the application UI -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' - properties: { - application: application - container: { - // This image is where the app's frontend code lives - image: 'ghcr.io/radius-project/samples/dapr-frontend:latest' - env: { - // An environment variable to tell the frontend container where to find the backend - CONNECTION_BACKEND_APPID: { - value: 'backend' - } - // An environment variable to override the default port that .NET Core listens on - ASPNETCORE_URLS: { - value: 'http://*:8080' - } - } - // The frontend container exposes port 8080, which is used to serve the UI - ports: { - ui: { - containerPort: 8080 - } - } - } - // The extension to configure Dapr on the container, which is used to invoke the backend - extensions: [ - { - kind: 'daprSidecar' - appId: 'frontend' - } - ] - } -} -//FRONTEND diff --git a/docs/content/tutorials/_index.md b/docs/content/tutorials/_index.md index 34cd1b70a..d96638e54 100644 --- a/docs/content/tutorials/_index.md +++ b/docs/content/tutorials/_index.md @@ -3,7 +3,7 @@ type: docs title: "Tutorial" linkTitle: "Tutorial" description: "End-to-end tutorial to configure Radius and deploy an application" -weight: 30 +weight: 300 --- This hands-on tutorial guides you through installing Radius, configuring Resource Types, Recipes, and Environments, and finally deploying the Todo List sample application. This tutorial will take approximately 30-60 minutes to complete. diff --git a/docs/content/tutorials/create-environment/index.md b/docs/content/tutorials/create-environment/index.md index 0fd17e388..5689d985b 100644 --- a/docs/content/tutorials/create-environment/index.md +++ b/docs/content/tutorials/create-environment/index.md @@ -3,7 +3,7 @@ type: docs title: "4. Create Environment" linkTitle: "4. Create Environment" description: "Create a Radius Environment to deploy the Application" -weight: 400 +weight: 300 --- In part four of this tutorial, you will: diff --git a/docs/content/tutorials/create-recipe/index.md b/docs/content/tutorials/create-recipe/index.md deleted file mode 100644 index e64a69acb..000000000 --- a/docs/content/tutorials/create-recipe/index.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -type: docs -title: "3. Create Recipes" -linkTitle: "3. Create Recipes" -description: "Create Bicep or Terraform Recipes that implement the Resource Type" -weight: 300 ---- - -Recipes define how a resource is deployed. In part three of this tutorial, you will create a Terraform or Bicep Recipe for the PostgreSQL Resource Type. - -## Create a Recipe for the PostgreSQL Resource Type - -Recipes can be either Terraform configurations or Bicep templates. Select the tab for the IaC language you prefer. - -{{< tabs Terraform Bicep >}}{{% codetab %}} - -Terraform configuration are stored in a Git repository for Radius to access the Recipe. For this tutorial, the [Terraform Recipe](https://github.com/radius-project/docs/tree/v0.56/docs/content/tutorials/create-recipe/recipes/terraform/main.tf) has already been created and stored in the Radius docs repository. Hence, there are no actual steps to complete for this section of the tutorial. What follows is a walkthrough of the Radius-specific aspects of the Terraform configuration. - -1. **Radius metadata via `context` variable** - - Radius automatically injects a variable called `context`. The context variable contains the Resource Type's and the Environment's properties. To use this metadata within the Terraform configuration, a variable must be defined within the `main.tf` or `variables.tf` file. - - ```tf - variable "context" { - description = "Radius-provided object containing information about the resource calling the Recipe." - type = any - } - ``` - Refer to the [context schema]({{< ref context-schema>}}) for the available properties. - -2. **Variables for Recipe customization** - - The `memory` variable allows customizing the memory request for the PostgreSQL container based on the `size` property defined in the Resource Type. - ```tf - variable "memory" { - description = "Memory limits for the PostgreSQL container" - type = map(object({ - memoryRequest = string - })) - default = { - S = { - memoryRequest = "512Mi" - }, - M = { - memoryRequest = "1Gi" - } - L = { - memoryRequest = "2Gi" - } - - } - ``` - It is then used in the Kubernetes Deployment: - - ```tf - resources { - requests = { - memory = var.memory[var.context.resource.properties.size].memoryRequest - } - } - ``` - -3. **Result output** - - Radius requires Terraform configuration to have a `result` output defined which provides Radius with the values for each read-only property on the Resource Type. Since the postgreSqlDatabases Resource Type has five read-only properties, each are specified within the `result`. - - ```tf - output "result" { - value = { - values = { - host = "${kubernetes_service.postgres.metadata[0].name}.${kubernetes_service.postgres.metadata[0].namespace}.svc.cluster.local" - port = local.port - database = "postgres_db" - username = "postgres" - password = random_password.password.result - } - } - } - ``` - -{{% /codetab %}} -{{% codetab %}} - -Bicep templates are stored in an OCI registry for Radius to access the Recipe. For this tutorial, the [Bicep Recipe](https://github.com/radius-project/docs/tree/v0.56/docs/content/tutorials/create-recipe/recipes/bicep/kubernetes-postgresql.bicep) has already been created and stored in the Radius OCI registry. Hence, there are no actual steps to complete for this section of the tutorial. What follows is a walkthrough of the Radius-specific aspects of the Bicep template. - -1. **Radius metadata via `context` variable** - - Radius automatically injects a `context` parameter. The context parameter contains the Resource Type's and the Environment's properties. To use this metadata within the Bicep template, a `context` parameter must be defined. - - ```bicep - @description('Information about what resource is calling this Recipe. Generated by Radius.') - param context object - ``` - Refer to the [context schema]({{< ref context-schema>}}) for the available properties. - -1. **Variables for Recipe customization** - - The `memory` variable allows customizing the memory request for the PostgreSQL container based on the `size` property defined in the Resource Type. - - ```bicep - @description('Memory limits for the PostgreSQL container') - var memory ={ - S: { - memoryRequest: '512Mi' - } - M: { - memoryRequest: '1Gi' - } - L: { - memoryRequest: '2Gi' - } - } - ``` - It is then used in the Kubernetes Deployment: - - ```bicep - resources: { - requests: { - memory: memory[context.resource.properties.size].memoryRequest - } - } - ``` - -1. **Result output** - - Radius requires Bicep templates to have a `result` output defined which provides Radius with the values for each read-only property on the Resource Type. Since the postgreSqlDatabases Resource Type has five read-only properties, each are specified within the `result`. - - ```bicep - output result object = { - values: { - host: '${svc.metadata.name}.${svc.metadata.namespace}.svc.cluster.local' - port: port - database: database - username: user - password: password - } - } - ``` - -{{% /codetab %}} -{{< /tabs >}} - -In part four, you will create an Environment which uses the new Recipe. -

-{{< button text="Next step: Create Environment" page="create-environment" color="primary" >}} diff --git a/docs/content/tutorials/create-resource-type/index.md b/docs/content/tutorials/create-resource-type/index.md index 2c8b01471..8b7e507f1 100644 --- a/docs/content/tutorials/create-resource-type/index.md +++ b/docs/content/tutorials/create-resource-type/index.md @@ -95,6 +95,6 @@ Navigate to [http://localhost:7007/resource-types/Radius.Data/postgreSqlDatabase {{< image src="resource-type.png" alt="Radius Resource types in Dashboard" width="700px" >}}

-In part three of this tutorial, you will create a Recipe to deploy the PostgreSQL Resource Type you just created. +Next, learn how to author and store a recipe that implements a Resource Type.
-{{< button text="Next Step: Create Recipes" page="create-recipe" color="primary" >}} +{{< button text="Next step: Author a recipe" page="extensibility/recipes" color="primary" >}} diff --git a/docs/content/tutorials/deploy-application/bicepconfig.json b/docs/content/tutorials/deploy-application/bicepconfig.json index 7a8b8e2f5..a199e3586 100644 --- a/docs/content/tutorials/deploy-application/bicepconfig.json +++ b/docs/content/tutorials/deploy-application/bicepconfig.json @@ -1,11 +1,7 @@ // The bicepconfig.json file is needed so the bicep files for this tutorial can be compiled with the correct setup { - "experimentalFeaturesEnabled": { - "extensibility": true - }, "extensions": { "radius": "br:biceptypes.azurecr.io/radius:latest", - "aws": "br:biceptypes.azurecr.io/aws:latest", "radiusResources": "radiusResources.tgz" } } \ No newline at end of file diff --git a/docs/content/tutorials/deploy-application/index.md b/docs/content/tutorials/deploy-application/index.md index 6da391144..a425499eb 100644 --- a/docs/content/tutorials/deploy-application/index.md +++ b/docs/content/tutorials/deploy-application/index.md @@ -3,7 +3,7 @@ type: docs title: "5. Deploy Application" linkTitle: "5. Deploy Application" description: "Learn how to deploy, and manage a Radius Application" -weight: 600 +weight: 400 --- In part five of this tutorial, you will deploy the Todo List Application to the Environment. @@ -107,4 +107,4 @@ rad uninstall kubernetes --purge ```
-{{< button text="Next step: Explore How-To Guides" page="guides" >}} \ No newline at end of file +{{< button text="Next step: Deploy Applications" page="applications" >}} \ No newline at end of file diff --git a/docs/content/tutorials/install-radius/index.md b/docs/content/tutorials/install-radius/index.md index ef4b64249..4ffb1f0e7 100644 --- a/docs/content/tutorials/install-radius/index.md +++ b/docs/content/tutorials/install-radius/index.md @@ -4,8 +4,6 @@ title: "1. Install Radius" linkTitle: "1. Install Radius" description: "Learn how to install Radius" weight: 100 -aliases: - - /installation/ --- In part one, you will install Radius on an existing Kubernetes cluster. diff --git a/docs/layouts/_td-content-after-header.html b/docs/layouts/_td-content-after-header.html new file mode 100644 index 000000000..f6fae9ed5 --- /dev/null +++ b/docs/layouts/_td-content-after-header.html @@ -0,0 +1,13 @@ +{{/* + Site-wide preview-release banner. + + This overrides Docsy's empty "_td-content-after-header" content view, which + renders immediately after the page title/description header and before the + page body. Placing the banner here shows it on every content page (single and + list) without editing individual Markdown files. The markup mirrors the Docsy + `alert` shortcode (color="warning"). +*/ -}} + diff --git a/docs/layouts/partials/hooks/body-end.html b/docs/layouts/partials/hooks/body-end.html index 673b0197f..6dbdd7b92 100644 --- a/docs/layouts/partials/hooks/body-end.html +++ b/docs/layouts/partials/hooks/body-end.html @@ -1,7 +1,31 @@ {{/* Docsy "body-end" hook: markup injected just before . - Intentionally empty. Analytics (Microsoft Clarity) is loaded from the + Analytics (Microsoft Clarity) is loaded from the "head-end.html" hook, and code-block copy buttons are provided by Docsy's - built-in click-to-copy feature, so no scripts are needed here. + built-in click-to-copy feature. */}} + diff --git a/docs/layouts/partials/section-index.html b/docs/layouts/partials/section-index.html index 04d814f1e..94b18d0b2 100644 --- a/docs/layouts/partials/section-index.html +++ b/docs/layouts/partials/section-index.html @@ -56,7 +56,7 @@
{{- .Title -}}
-

{{ .Description | markdownify }}

+ {{ with .Description }}

{{ . | markdownify }}

{{ end }} {{ end }} {{ end }} @@ -65,23 +65,29 @@