add notes about namespacing

Signed-off-by: Hannah Hunter <[email protected]>
dapr · Sep 4, 2024 · 27a392e · 27a392e
1 parent 730a996
commit 27a392e
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 11 deletions.
diff --git a/daprdocs/content/en/reference/resource-specs/component-schema.md b/daprdocs/content/en/reference/resource-specs/component-schema.md
@@ -8,27 +8,31 @@ description: "The basic spec for a Dapr component"
 
 Dapr defines and registers components using a [resource specifications](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/). All components are defined as a resource and can be applied to any hosting environment where Dapr is running, not just Kubernetes.
 
+{{% alert title="Note" color="primary" %}}
+Any component can be restricted to a particular [namepsace]({{< ref isolation-concept.md >}}) and restricted access through scopes to any particular set of applications.
+{{% /alert %}}
+
 ## Format
 
 ```yaml
 apiVersion: dapr.io/v1alpha1
 kind: Component
 auth: 
- secretstore: [SECRET-STORE-NAME]
+ secretstore: <REPLACE-WITH-SECRET-STORE-NAME>
 metadata:
-  name: [COMPONENT-NAME]
-  namespace: [COMPONENT-NAMESPACE]
+  name: <REPLACE-WITH-COMPONENT-NAME>
+  namespace: <REPLACE-WITH-COMPONENT-NAMESPACE>
 spec:
-  type: [COMPONENT-TYPE]
+  type: <REPLACE-WITH-COMPONENT-TYPE>
   version: v1
-  initTimeout: [TIMEOUT-DURATION]
-  ignoreErrors: [BOOLEAN]
+  initTimeout: <REPLACE-WITH-TIMEOUT-DURATION>
+  ignoreErrors: <REPLACE-WITH-BOOLEAN>
   metadata:
-  - name: [METADATA-NAME]
-    value: [METADATA-VALUE]
+  - name: <REPLACE-WITH-METADATA-NAME>
+    value: <REPLACE-WITH-METADATA-VALUE>
 scopes:
-  - [APPID]
-  - [APPID]
+  - <REPLACE-WITH-APPID>
+  - <REPLACE-WITH-APPID>
 ```
 
 ## Spec fields

diff --git a/daprdocs/content/en/reference/resource-specs/httpendpoints-schema.md b/daprdocs/content/en/reference/resource-specs/httpendpoints-schema.md
@@ -10,6 +10,10 @@ aliases:
 
 The `HTTPEndpoint` is a Dapr resource that is used to enable the invocation of non-Dapr endpoints from a Dapr application.
 
+{{% alert title="Note" color="primary" %}}
+Any HTTPEndpoint resource can be restricted to a particular [namepsace]({{< ref isolation-concept.md >}}) and restricted access through scopes to any particular set of applications.
+{{% /alert %}}
+
 ## Format
 
 ```yaml

diff --git a/daprdocs/content/en/reference/resource-specs/resiliency-schema.md b/daprdocs/content/en/reference/resource-specs/resiliency-schema.md
@@ -8,6 +8,10 @@ description: "The basic spec for a Dapr resiliency resource"
 
 The `Resiliency` Dapr resource allows you to define and apply fault tolerance resiliency policies. Resiliency specs are applied when the Dapr sidecar starts. 
 
+{{% alert title="Note" color="primary" %}}
+Any resiliency resource can be restricted to a particular [namepsace]({{< ref isolation-concept.md >}}) and restricted access through scopes to any particular set of applications.
+{{% /alert %}}
+
 ## Format
 
 ```yml

diff --git a/daprdocs/content/en/reference/resource-specs/subscription-schema.md b/daprdocs/content/en/reference/resource-specs/subscription-schema.md
@@ -6,7 +6,13 @@ weight: 2000
 description: "The basic spec for a Dapr subscription"
 ---
 
-The `Subscription` Dapr resource allows you to subscribe declaratively to a topic using an external component YAML file. This guide demonstrates two subscription API versions:
+The `Subscription` Dapr resource allows you to subscribe declaratively to a topic using an external component YAML file. 
+
+{{% alert title="Note" color="primary" %}}
+Any subscription can be restricted to a particular [namepsace]({{< ref isolation-concept.md >}}) and restricted access through scopes to any particular set of applications.
+{{% /alert %}}
+
+This guide demonstrates two subscription API versions:
 
 - `v2alpha` (default spec)
 - `v1alpha1` (deprecated)