Dapr resource specs on Dapr Docs

Component spec

Mon, 01 Jan 0001 00:00:00 +0000

Dapr defines and registers components using a resource specifications. All components are defined as a resource and can be applied to any hosting environment where Dapr is running, not just Kubernetes.

Typically, components are restricted to a particular namespace and restricted access through scopes to any particular set of applications. The namespace is either explicit on the component manifest itself, or set by the API server, which derives the namespace through context with applying to Kubernetes.

Subscription spec

Mon, 01 Jan 0001 00:00:00 +0000

The Subscription Dapr resource allows you to subscribe declaratively to a topic using an external component YAML file.

Note

Any subscription can be restricted to a particular namespace and restricted access through scopes to any particular set of applications.

This guide demonstrates two subscription API versions:

v2alpha1 (default spec)
v1alpha1 (deprecated)

`v2alpha1` format

The following is the basic v2alpha1 spec for a Subscription resource. v2alpha1 is the default spec for the subscription API.

Resiliency spec

Mon, 01 Jan 0001 00:00:00 +0000

The Resiliency Dapr resource allows you to define and apply fault tolerance resiliency policies. Resiliency specs are applied when the Dapr sidecar starts.

Note

Any resiliency resource can be restricted to a particular namepsace and restricted access through scopes to any particular set of applications.

Format

apiVersion: dapr.io/v1alpha1
kind: Resiliency
metadata:
 name: <REPLACE-WITH-RESOURCE-NAME>
version: v1alpha1
scopes:
 - <REPLACE-WITH-SCOPED-APPIDS>
spec:
 policies: # Required
 timeouts:
 timeoutName: <REPLACE-WITH-TIME-VALUE> # Replace with any unique name
 retries:
 retryName: # Replace with any unique name
 policy: <REPLACE-WITH-VALUE>
 duration: <REPLACE-WITH-VALUE>
 maxInterval: <REPLACE-WITH-VALUE>
 maxRetries: <REPLACE-WITH-VALUE>
 matching:
 httpStatusCodes: <REPLACE-WITH-VALUE>
 gRPCStatusCodes: <REPLACE-WITH-VALUE>
 circuitBreakers:
 circuitBreakerName: # Replace with any unique name
 maxRequests: <REPLACE-WITH-VALUE>
 timeout: <REPLACE-WITH-VALUE> 
 trip: <REPLACE-WITH-CONSECUTIVE-FAILURE-VALUE>
targets: # Required
 apps:
 appID: # Replace with scoped app ID
 timeout: <REPLACE-WITH-TIMEOUT-NAME>
 retry: <REPLACE-WITH-RETRY-NAME>
 circuitBreaker: <REPLACE-WITH-CIRCUIT-BREAKER-NAME>
 actors:
 myActorType: 
 timeout: <REPLACE-WITH-TIMEOUT-NAME>
 retry: <REPLACE-WITH-RETRY-NAME>
 circuitBreaker: <REPLACE-WITH-CIRCUIT-BREAKER-NAME>
 circuitBreakerCacheSize: <REPLACE-WITH-VALUE>
 components:
 componentName: # Replace with your component name
 outbound:
 timeout: <REPLACE-WITH-TIMEOUT-NAME>
 retry: <REPLACE-WITH-RETRY-NAME>
 circuitBreaker: <REPLACE-WITH-CIRCUIT-BREAKER-NAME>

Spec fields

Field	Required	Details	Example
policies	Y	The configuration of resiliency policies, including: `timeouts` `retries` `circuitBreakers` See more examples with all of the built-in policies	timeout: `general` retry: `retryForever` circuit breaker: `simpleCB`
targets	Y	The configuration for the applications, actors, or components that use the resiliency policies. See more examples in the resiliency targets guide	`apps` `components` `actors`

Learn more about resiliency policies and targets

HTTPEndpoint spec

Mon, 01 Jan 0001 00:00:00 +0000

The HTTPEndpoint is a Dapr resource that is used to enable the invocation of non-Dapr endpoints from a Dapr application.

Note

Any HTTPEndpoint resource can be restricted to a particular namepsace and restricted access through scopes to any particular set of applications.

Format

apiVersion: dapr.io/v1alpha1
kind: HTTPEndpoint
metadata:
 name: <NAME> 
spec:
 baseUrl: <REPLACE-WITH-BASEURL> # Required. Use "http://" or "https://" prefix.
 headers: # Optional
 - name: <REPLACE-WITH-A-HEADER-NAME>
 value: <REPLACE-WITH-A-HEADER-VALUE>
 - name: <REPLACE-WITH-A-HEADER-NAME>
 secretKeyRef:
 name: <REPLACE-WITH-SECRET-NAME>
 key: <REPLACE-WITH-SECRET-KEY>
 clientTLS:
 rootCA:
 secretKeyRef:
 name: <REPLACE-WITH-SECRET-NAME>
 key: <REPLACE-WITH-SECRET-KEY>
 certificate:
 secretKeyRef:
 name: <REPLACE-WITH-SECRET-NAME>
 key: <REPLACE-WITH-SECRET-KEY>
 privateKey:
 secretKeyRef:
 name: <REPLACE-WITH-SECRET-NAME>
 key: <REPLACE-WITH-SECRET-KEY>
scopes: # Optional
 - <REPLACE-WITH-SCOPED-APPIDS>
auth: # Optional
 secretStore: <REPLACE-WITH-SECRETSTORE>

Spec fields

Field	Required	Details	Example
baseUrl	Y	Base URL of the non-Dapr endpoint	`"https://api.github.com"`, `"http://api.github.com"`
headers	N	HTTP request headers for service invocation	`name: "Accept-Language" value: "en-US"` `name: "Authorization" secretKeyRef.name: "my-secret" secretKeyRef.key: "myGithubToken"`
clientTLS	N	Enables TLS authentication to an endpoint with any standard combination of root certificate, client certificate and private key

Learn how to invoke non-Dapr endpoints.

Configuration spec

Mon, 01 Jan 0001 00:00:00 +0000

The Configuration is a Dapr resource that is used to configure the Dapr sidecar, control plane, and others.

Sidecar format

apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
 name: <REPLACE-WITH-NAME>
 namespace: <REPLACE-WITH-NAMESPACE>
spec:
 api:
 allowed:
 - name: <REPLACE-WITH-API>
 version: <VERSION>
 protocol: <HTTP-OR-GRPC>
 tracing:
 samplingRate: <REPLACE-WITH-INTEGER>
 stdout: true
 otel:
 endpointAddress: <REPLACE-WITH-ENDPOINT-ADDRESS>
 isSecure: <TRUE-OR-FALSE>
 protocol: <HTTP-OR-GRPC>
 headers:
 - name: <HEADER-NAME>
 value: <HEADER-VALUE>
 - name: <HEADER-NAME>
 secretKeyRef:
 name: <SECRET-STORE-NAME>
 key: <SECRET-KEY>
 timeout: <DURATION>
 metrics:
 enabled: <TRUE-OR-FALSE>
 rules:
 - name: <METRIC-NAME>
 labels:
 - name: <LABEL-NAME>
 regex: {}
 recordErrorCodes: <TRUE-OR-FALSE>
 latencyDistributionBuckets:
 - <BUCKET-VALUE-MS-0>
 - <BUCKET-VALUE-MS-1>
 http:
 increasedCardinality: <TRUE-OR-FALSE>
 pathMatching: 
 - <PATH-A>
 - <PATH-B>
 excludeVerbs: <TRUE-OR-FALSE>
 httpPipeline: # for incoming http calls
 handlers:
 - name: <HANDLER-NAME>
 type: <HANDLER-TYPE>
 appHttpPipeline: # for outgoing http calls
 handlers:
 - name: <HANDLER-NAME>
 type: <HANDLER-TYPE>
 nameResolution:
 component: <NAME-OF-NAME-RESOLUTION-COMPONENT>
 version: <NAME-RESOLUTION-COMPONENT-VERSION>
 configuration:
 <NAME-RESOLUTION-COMPONENT-METADATA-CONFIGURATION>
 secrets:
 scopes:
 - storeName: <NAME-OF-SCOPED-STORE>
 defaultAccess: <ALLOW-OR-DENY>
 deniedSecrets: <REPLACE-WITH-DENIED-SECRET>
 components:
 deny:
 - <COMPONENT-TO-DENY>
 accessControl:
 defaultAction: <ALLOW-OR-DENY>
 trustDomain: <REPLACE-WITH-TRUST-DOMAIN>
 policies:
 - appId: <APP-NAME>
 defaultAction: <ALLOW-OR-DENY>
 trustDomain: <REPLACE-WITH-TRUST-DOMAIN>
 namespace: "default"
 operations:
 - name: <OPERATION-NAME>
 httpVerb: ['POST', 'GET']
 action: <ALLOW-OR-DENY>

Spec fields

Field	Required	Details	Example
accessControl	N	Applied to Dapr sidecar for the called application. Enables the configuration of policies that restrict what operations calling applications can perform (via service invocation) on the called appliaction.	Learn more about the `accessControl` configuration.
api	N	Used to enable only the Dapr sidecar APIs used by the application.	Learn more about the `api` configuration.
httpPipeline	N	Configure API middleware pipelines	Middleware pipeline configuration overview Learn more about the `httpPipeline` configuration.
appHttpPipeline	N	Configure application middleware pipelines	Middleware pipeline configuration overview Learn more about the `appHttpPipeline` configuration.
components	N	Used to specify a denylist of component types that can’t be initialized.	Learn more about the `components` configuration.
features	N	Defines the preview features that are enabled/disabled.	Learn more about the `features` configuration.
logging	N	Configure how logging works in the Dapr runtime.	Learn more about the `logging` configuration.
metrics	N	Enable or disable metrics for an application.	Learn more about the `metrics` configuration.
nameResolution	N	Name resolution configuration spec for the service invocation building block.	Learn more about the `nameResolution` configuration per components.
secrets	N	Limit the secrets to which your Dapr application has access.	Learn more about the `secrets` configuration.
tracing	N	Turns on tracing for an application.	Learn more about the `tracing` configuration.

Control plane format

The daprsystem configuration file installed with Dapr applies global settings and is only set up when Dapr is deployed to Kubernetes.

Dapr resource specs on Dapr Docs

Component spec

Subscription spec

Note

v2alpha1 format

Resiliency spec

Note

Format

Spec fields

Related links

HTTPEndpoint spec

Note

Format

Spec fields

Related links

Configuration spec

Sidecar format

Spec fields

Control plane format

`v2alpha1` format