Update limitations page to warn users that naming a gateway with the …

…same name as a container causes an error (#1039) * Adding a known limitation for gateway resources Signed-off-by: jasonviviano <[email protected]> * Update docs/content/reference/limitations.md Signed-off-by: jasonviviano <[email protected]> * Update docs/content/reference/limitations.md Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: jasonviviano <[email protected]> * Added the error string for gateway resources sharing names with other resources. Signed-off-by: jasonviviano <[email protected]> * Update docs/content/reference/limitations.md Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: jasonviviano <[email protected]> --------- Signed-off-by: jasonviviano <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]>
radius-project · Feb 13, 2024 · ae97e68 · ae97e68 · tdeheurles · Feb 23, 2024
1 parent 991041a
commit ae97e68
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md
@@ -34,6 +34,16 @@ As a workaround do not use underscores in resource names. Additional validation
 
 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.
+
 ## rad CLI
 
 ### Application and resource names are lower-cased after deployment