Resiliency spec

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.

Format

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Resiliency
  3. metadata:
  4.   name: <REPLACE-WITH-RESOURCE-NAME>
  5. version: v1alpha1
  6. scopes:
  7.   - <REPLACE-WITH-SCOPED-APPIDS>
  8. spec:
  9.   policies: # Required
  10.     timeouts:
  11.       timeoutName: <REPLACE-WITH-TIME-VALUE> # Replace with any unique name
  12.     retries:
  13.       retryName: # Replace with any unique name
  14.         policy: <REPLACE-WITH-VALUE>
  15.         duration: <REPLACE-WITH-VALUE>
  16.         maxInterval: <REPLACE-WITH-VALUE>
  17.         maxRetries: <REPLACE-WITH-VALUE>
  18.     circuitBreakers:
  19.       circuitBreakerName: # Replace with any unique name
  20.         maxRequests: <REPLACE-WITH-VALUE>
  21.         timeout: <REPLACE-WITH-VALUE> 
  22.         trip: <REPLACE-WITH-CONSECUTIVE-FAILURE-VALUE>
  23. targets: # Required
  24.     apps:
  25.       appID: # Replace with scoped app ID
  26.         timeout: <REPLACE-WITH-TIMEOUT-NAME>
  27.         retry: <REPLACE-WITH-RETRY-NAME>
  28.         circuitBreaker: <REPLACE-WITH-CIRCUIT-BREAKER-NAME>
  29.     actors:
  30.       myActorType: 
  31.         timeout: <REPLACE-WITH-TIMEOUT-NAME>
  32.         retry: <REPLACE-WITH-RETRY-NAME>
  33.         circuitBreaker: <REPLACE-WITH-CIRCUIT-BREAKER-NAME>
  34.         circuitBreakerCacheSize: <REPLACE-WITH-VALUE>
  35.     components:
  36.       componentName: # Replace with your component name
  37.         outbound:
  38.           timeout: <REPLACE-WITH-TIMEOUT-NAME>
  39.           retry: <REPLACE-WITH-RETRY-NAME>
  40.           circuitBreaker: <REPLACE-WITH-CIRCUIT-BREAKER-NAME>

Spec fields

FieldRequiredDetailsExample
policiesYThe 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
targetsYThe 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

Last modified March 21, 2024: Merge pull request #4082 from newbe36524/v1.13 (f4b0938)