update headers for consistency

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
This commit is contained in:
Hannah Hunter 2023-06-27 15:24:11 -04:00
parent d6ec5e71ef
commit f4a5ad3f41
5 changed files with 82 additions and 4 deletions

View File

@ -26,7 +26,7 @@ spec:
value: [METADATA-VALUE]
```
## Fields
## Spec fields
| Field | Required | Details | Example |
|--------------------|:--------:|---------|---------|

View File

@ -0,0 +1,76 @@
---
type: docs
title: "Configuration spec"
linkTitle: "Configuration"
description: "The basic spec for a Dapr Configuration resource"
weight: 5000
---
The `Configuration` is a Dapr resource that is used to configure the Dapr sidecar, control-plane, and others.
## Format
```yaml
apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
name: <REPLACE-WITH-NAME>
namespace: <REPLACE-WITH-NAMESPACE>
spec:
tracing:
samplingRate: "1"
stdout: true
otel:
endpointAddress: "localhost:4317"
isSecure: false
protocol: "grpc"
httpPipeline:
handlers:
- name: oauth2
type: middleware.http.oauth2
secrets:
scopes:
- storeName: localstore
defaultAccess: allow
deniedSecrets: ["redis-password"]
components:
deny:
- bindings.smtp
- secretstores.local.file
accessControl:
defaultAction: deny
trustDomain: "public"
policies:
- appId: app1
defaultAction: deny
trustDomain: 'public'
namespace: "default"
operations:
- name: /op1
httpVerb: ['POST', 'GET']
action: deny
- name: /op2/*
httpVerb: ["*"]
action: allow
```
## Spec fields
| Field | Required | Details | Example |
|--------------------|:--------:|---------|---------|
| accessControl | Y | Defines the data structure for the configuration spec | |
| api | N | Describes the configuration for the Dapr APIs | |
| appHttpPipeline | N | Configuration spec for defining the middleware pipeline | |
| components | N | Describes the configuration for Dapr components | |
| features | N | Defines the features that are enabled/disabled | |
| httpPipeline | N | Configuration spec for defining the middleware pipeline | |
| logging | N | Used to configure logging | |
| metric | N | Defines the metrics configuration | |
| mtls | N | Defines the mTLS configuration | |
| nameResolution | N | Name resolution configuration spec | |
| secrets | N | Configures secrets for your sidecar or control-plane | |
| tracing | N | Defines distributed tracing configuration | |
## Related links
- [Learn more about how to use configuration specs]({{< ref configuration-overview.md >}})

View File

@ -10,7 +10,7 @@ aliases:
The `HTTPEndpoint` is a Dapr resource that is used to enable the invocation of non-Dapr endpoints from a Dapr application.
## HTTPEndpoint format
## Format
```yaml
apiVersion: dapr.io/v1alpha1

View File

@ -8,6 +8,8 @@ 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.
## Format
```yml
apiVersion: dapr.io/v1alpha1
kind: Resiliency

View File

@ -11,7 +11,7 @@ The `Subscription` Dapr resource allows you to subscribe declaratively to a topi
- `v2alpha` (default spec)
- `v1alpha1` (deprecated)
## `v2alpha1`
## `v2alpha1` format
The following is the basic `v2alpha1` spec for a `Subscription` resource. `v2alpha1` is the default spec for the subscription API.
@ -48,7 +48,7 @@ scopes:
| bulksubscribe | N | Enable bulk subscribe properties. | `true`, `false` |
## `v1alpha1`
## `v1alpha1` format
The following is the basic version `v1alpha1` spec for a `Subscription` resource. `v1alpha1` is now deprecated.