Fix output object name (value -> result) (#658)

* Fix output object name (value -> result) * Spellcheck * Move Bicep into snippet --------- Co-authored-by: Aaron Crawfis <[email protected]>
radius-project · Aug 11, 2023 · 4d85c27 · 4d85c27
1 parent d11699a
commit 4d85c27
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 14 deletions.
diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt
@@ -425,3 +425,6 @@ tcp
 BucketName
 roadmap
 Balancer
+azureCache
+listKeys
+primaryKey
diff --git a/docs/content/operations/custom-recipes/index.md b/docs/content/operations/custom-recipes/index.md
@@ -66,20 +66,9 @@ Linking is done automatically for any new Azure or AWS resource ([_Kubernetes co
 
 [Bicep `existing`](https://learn.microsoft.com/azure/azure-resource-manager/bicep/existing-resource) resources are not currently linked as part of Recipe-enabled resources, meaning you won't see them in the definition of the resource and they aren't [deleted later on](#infrastructure-lifecycle), unlike new resources.
 
-You can also manually link resources via the `values` output of a Recipe. This can be used for Kubernetes resources, [which aren't currently linked automatically]({{< ref "faq#why-do-i-need-to-manually-output-a-kubernetes-ucp-id-as-part-of-my-bicep-recipe" >}}). To link a resource to a Recipe-enabled resource, add its ID to an array of resource IDs:
-
-```bicep
-// ....resources defined above
-
-output values object = {
-  resources: [
-    // ID via reference (Azure/AWS)
-    resource1.id
-    // ID via manual entry (Kubernetes)
-    '/planes/kubernetes/local/namespaces/${deployment.metadata.namespace}/providers/apps/Deployment/${deployment.metadata.name}'
-  ]
-}
-```
+You can also manually link resources via the `result` output of a Recipe. This can be used for Kubernetes resources, [which aren't currently linked automatically]({{< ref "faq#why-do-i-need-to-manually-output-a-kubernetes-ucp-id-as-part-of-my-bicep-recipe" >}}). To link a resource to a Recipe-enabled resource, add its ID to an array of resource IDs:
+
+{{< rad file="snippets/recipe-outputs.bicep" embed=true marker="//OUTVALUES" >}}
 
 ### Step 5: Store your template in a Bicep registry
 

diff --git a/docs/content/operations/custom-recipes/snippets/recipe-outputs.bicep b/docs/content/operations/custom-recipes/snippets/recipe-outputs.bicep
@@ -0,0 +1,19 @@
+resource azureResource 'Microsoft.Cache/redis@2022-06-01' existing = {
+  name: 'mycache'
+}
+
+param svc object
+param deployment object
+
+//OUTVALUES
+output result object = {
+  resources: [
+    '/planes/kubernetes/local/namespaces/${svc.metadata.namespace}/providers/core/Service/${svc.metadata.name}'
+    '/planes/kubernetes/local/namespaces/${deployment.metadata.namespace}/providers/apps/Deployment/${deployment.metadata.name}'
+  ]
+  values: {
+    host: '${svc.metadata.name}.${svc.metadata.namespace}.svc.cluster.local'
+    port: 6379
+  }
+}
+//OUTVALUES