Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update component schema with current values #3743

Merged
merged 9 commits into from
Sep 25, 2023
Merged

Update component schema with current values #3743

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
79dca65
update schema with values
hhunter-ms Sep 18, 2023
8549c16
Merge branch 'v1.11' into issue_3638
msfussell Sep 19, 2023
1da77a3
Merge branch 'v1.11' into issue_3638
msfussell Sep 22, 2023
97d323b
Merge branch 'v1.11' into issue_3638
msfussell Sep 25, 2023
e2a4f64
Update daprdocs/content/en/reference/resource-specs/component-schema.md
hhunter-ms Sep 25, 2023
eb1c778
Update daprdocs/content/en/reference/resource-specs/component-schema.md
hhunter-ms Sep 25, 2023
e2b6321
Merge branch 'v1.11' into issue_3638
hhunter-ms Sep 25, 2023
836c353
link to example
hhunter-ms Sep 25, 2023
0880798
Merge branch 'v1.11' into issue_3638
msfussell Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions daprdocs/content/en/reference/resource-specs/component-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Dapr defines and registers components using a [resource specifications](https://
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
auth:
hhunter-ms marked this conversation as resolved.
Show resolved Hide resolved
metadata:
name: [COMPONENT-NAME]
namespace: [COMPONENT-NAMESPACE]
Expand All @@ -24,6 +25,9 @@ spec:
metadata:
- name: [METADATA-NAME]
value: [METADATA-VALUE]
scopes:
- [APPID]
- [APPID]
```

## Spec fields
Expand All @@ -32,6 +36,8 @@ spec:
|--------------------|:--------:|---------|---------|
| apiVersion | Y | The version of the Dapr (and Kubernetes if applicable) API you are calling | `dapr.io/v1alpha1`
| kind | Y | The type of resource. For components is must always be `Component` | `Component`
| auth | N | The authentication details for the component |
hhunter-ms marked this conversation as resolved.
Show resolved Hide resolved
| scopes | N | The applications the component is limited to, specified by their app IDs | `order-processor`, `checkout`
| **metadata** | - | **Information about the component registration** |
| metadata.name | Y | The name of the component | `prod-statestore`
| metadata.namespace | N | The namespace for the component for hosting environments with namespaces | `myapp-namespace`
Expand All @@ -41,6 +47,7 @@ spec:
| spec.initTimeout | N | The timeout duration for the initialization of the component. Default is 5s | `5m`, `1h`, `20s`
| spec.ignoreErrors | N | Tells the Dapr sidecar to continue initialization if the component fails to load. Default is false | `false`
| **spec.metadata** | - | **A key/value pair of component specific configuration. See your component definition for fields**|
| spec.metadata.name | Y | The name of the component-specific property and its value | `- name: secretsFile` <br> `value: secrets.json`

### Templated metadata values

Expand Down
Loading