Update the page on known issues and limitations (#801)

* Add supported resource types * update limitations * Update docs/content/reference/limitations.md * Update docs/content/reference/limitations.md Co-authored-by: Aaron Crawfis <[email protected]> --------- Co-authored-by: Aaron Crawfis <[email protected]>
radius-project · Oct 3, 2023 · 1be57e8 · 1be57e8
1 parent 509f3f7
commit 1be57e8
Show file tree

Hide file tree

Showing 2 changed files with 650 additions and 28 deletions.
diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md
@@ -26,13 +26,43 @@ This will be addressed further in a future release.
 
 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.
+
+## 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.
+
 ## Bicep & Deployment Engine
 
 ### Currently using a forked version of Bicep
 
-While Radius is still in the private preview stage, a fork of the Bicep compiler is being used while the Radius team works with the Bicep team and community to build in the proper support to move back into the primary version. This results in:
+Radius is currently using a forked version of Bicep compiler to support Radius specific features. This is a point-in-time limitation that will be addressed in the future as the Radius team works with the Bicep team and the community to upstream the extensibility updates. This results in the following limitations:
 
-- The "Bicep" VS Code extension must be disabled in favor of the "Bicep (Radius)" extension
+- The "Bicep" VS Code extension must be disabled in favor of the "Radius Bicep" extension
 - The forked Bicep compiler will be out of date compared to the most recent Bicep public build
 - `az bicep` and `bicep` are not supported with Radius. Use `rad deploy` instead.
 
@@ -54,34 +84,12 @@ 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.
 
-## Containers
-
-## 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
-```
+### Radius Bicep AWS limitations
 
-### Cannot use underscores in resource names
+Some of the [AWS resource types](/resource-schema/aws) are 'non-idempotent', this means that this resource type is assigned a primary identifier at deployment time and is currently not supported by Radius Bicep.
 
-Using an underscore in a resource name will result in an error.
+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 do not use underscores in resource names. Additional validation will be added in a future release to help warn against improperly formatted resource names.
+As a workaround, you can try using [terraform recipes](https://docs.radapp.dev/guides/recipes/overview/) to deploy and manage those non-idempotent resource types.
 
-See [app name constraints]({{< ref "resource-schema.md#common-values" >}}) for more information.
-
-### 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.