mirror of https://github.com/dapr/docs.git
Remove direction metadata from output-only bindings
Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>
This commit is contained in:
parent
5010459694
commit
84e9dc1595
|
@ -76,14 +76,14 @@ Read the [Use output bindings to interface with external resources guide]({{< re
|
|||
|
||||
## Binding directions (optional)
|
||||
|
||||
You can provide the `direction` metadata field to indicate the direction(s) supported by the binding component. In doing so, the Dapr sidecar avoids the `"wait for the app to become ready"` state reducing the lifecycle dependency between the Dapr sidecar and the application:
|
||||
You can provide the `direction` metadata field to indicate the direction(s) supported by the binding component. In doing so, the Dapr sidecar avoids the `"wait for the app to become ready"` state, reducing the lifecycle dependency between the Dapr sidecar and the application:
|
||||
|
||||
- `"input"`
|
||||
- `"output"`
|
||||
- `"input, output"`
|
||||
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
It is highly recommended that all bindings should include the `direction` property.
|
||||
It is highly recommended that all input bindings should include the `direction` property.
|
||||
{{% /alert %}}
|
||||
|
||||
[See a full example of the bindings `direction` metadata.]({{< ref "bindings_api.md#binding-direction-optional" >}})
|
||||
|
|
|
@ -28,8 +28,6 @@ spec:
|
|||
value: "[access-key]"
|
||||
- name: bucket
|
||||
value: "[bucket]"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -44,13 +42,12 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `accessKeyID` | Y | Output | Access key ID credential. |
|
||||
| `accessKey` | Y | Output | Access key credential. |
|
||||
| `bucket` | Y | Output | Name of the storage bucket. |
|
||||
| `direction` | N | Output | Direction of the binding. | `"output"`
|
||||
|
||||
## Binding support
|
||||
|
||||
This component supports **output binding** with the following operations:
|
||||
- `create`: [Create object](#create-object)
|
||||
|
||||
- `create`: [Create object](#create-object)
|
||||
|
||||
### Create object
|
||||
|
||||
|
|
|
@ -26,8 +26,6 @@ spec:
|
|||
value: "[accessKey-secret]"
|
||||
- name: Endpoint
|
||||
value: "[endpoint]"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
## Spec metadata fields
|
||||
|
@ -37,13 +35,12 @@ spec:
|
|||
| `AccessKeyID` | Y | Output | Access key ID credential. |
|
||||
| `AccessKeySecret` | Y | Output | Access key credential secret |
|
||||
| `Endpoint` | Y | Output | Alicloud SLS endpoint. |
|
||||
| `direction` | N | Output | Direction of the binding. | `"output"`
|
||||
|
||||
## Binding support
|
||||
|
||||
This component supports **output binding** with the following operations:
|
||||
- `create`: [Create object](#create-object)
|
||||
|
||||
- `create`: [Create object](#create-object)
|
||||
|
||||
### Request format
|
||||
|
||||
|
|
|
@ -32,8 +32,6 @@ spec:
|
|||
value: "[table]"
|
||||
- name: endpoint
|
||||
value: "[endpoint]"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -49,13 +47,12 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `accessKey` | Y | Output | Access key credential. |
|
||||
| `instanceName` | Y | Output | Name of the instance. |
|
||||
| `tableName` | Y | Output | Name of the table. |
|
||||
| `direction` | N | Output | Direction of the binding. | `"output"`
|
||||
|
||||
## Binding support
|
||||
|
||||
This component supports **output binding** with the following operations:
|
||||
- `create`: [Create object](#create-object)
|
||||
|
||||
- `create`: [Create object](#create-object)
|
||||
|
||||
### Create object
|
||||
|
||||
|
|
|
@ -30,8 +30,6 @@ spec:
|
|||
secretKeyRef:
|
||||
name: <SECRET>
|
||||
key: "<SECRET-KEY-NAME>"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
## Spec metadata fields
|
||||
|
||||
|
@ -41,14 +39,15 @@ spec:
|
|||
| `key-id` | Y | Output | The identifier for the private key from the Apple Developer Portal | `"private-key-id`" |
|
||||
| `team-id` | Y | Output | The identifier for the organization or author from the Apple Developer Portal | `"team-id"` |
|
||||
| `private-key` | Y | Output| Is a PKCS #8-formatted private key. It is intended that the private key is stored in the secret store and not exposed directly in the configuration. See [here](#private-key) for more details | `"pem file"` |
|
||||
| `direction` | N | Output| The direction of the binding. | `"output"` |
|
||||
|
||||
### Private key
|
||||
|
||||
The APNS binding needs a cryptographic private key in order to generate authentication tokens for the APNS service.
|
||||
The private key can be generated from the Apple Developer Portal and is provided as a PKCS #8 file with the private key stored in PEM format.
|
||||
The private key should be stored in the Dapr secret store and not stored directly in the binding's configuration file.
|
||||
|
||||
A sample configuration file for the APNS binding is shown below:
|
||||
|
||||
```yaml
|
||||
apiVersion: dapr.io/v1alpha1
|
||||
kind: Component
|
||||
|
@ -68,7 +67,9 @@ spec:
|
|||
name: apns-secrets
|
||||
key: private-key
|
||||
```
|
||||
|
||||
If using Kubernetes, a sample secret configuration may look like this:
|
||||
|
||||
```yaml
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
|
|
|
@ -33,8 +33,6 @@ spec:
|
|||
# value: <integer>
|
||||
# - name: publicAccessLevel
|
||||
# value: <publicAccessLevel>
|
||||
# - name: direction
|
||||
# value: "output"
|
||||
```
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
|
||||
|
@ -51,7 +49,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `decodeBase64` | N | Output | Configuration to decode base64 file content before saving to Blob Storage. (In case of saving a file with binary content). Defaults to `false` | `true`, `false` |
|
||||
| `getBlobRetryCount` | N | Output | Specifies the maximum number of HTTP GET requests that will be made while reading from a RetryReader Defaults to `10` | `1`, `2`
|
||||
| `publicAccessLevel` | N | Output | Specifies whether data in the container may be accessed publicly and the level of access (only used if the container is created by Dapr). Defaults to `none` | `blob`, `container`, `none`
|
||||
| `direction` | N | Output | The direction of the binding. | `"output"`
|
||||
|
||||
### Azure Active Directory (AAD) authentication
|
||||
|
||||
|
|
|
@ -46,9 +46,6 @@ spec:
|
|||
# URL of the Worker (required if the Worker has been pre-created outside of Dapr)
|
||||
- name: workerUrl
|
||||
value: ""
|
||||
# Direction of the binding
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -64,7 +61,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `cfAccountID` | Y/N | Output | Cloudflare account ID. Required to have Dapr manage the worker. | `"456789abcdef8b5588f3d134f74ac"def`
|
||||
| `cfAPIToken` | Y/N | Output | API token for Cloudflare. Required to have Dapr manage the Worker. | `"secret-key"`
|
||||
| `workerUrl` | Y/N | Output | URL of the Worker. Required if the Worker has been pre-provisioned outside of Dapr. | `"https://mydaprqueue.mydomain.workers.dev"`
|
||||
| `direction` | N | Output | Direction of the binding. | `"output"`
|
||||
|
||||
> When you configure Dapr to create your Worker for you, you may need to set a longer value for the `initTimeout` property of the component, to allow enough time for the Worker script to be deployed. For example: `initTimeout: "120s"`
|
||||
|
||||
|
|
|
@ -11,8 +11,6 @@ aliases:
|
|||
|
||||
To setup commercetools GraphQL binding create a component of type `bindings.commercetools`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
apiVersion: dapr.io/v1alpha1
|
||||
kind: Component
|
||||
|
@ -34,9 +32,8 @@ spec:
|
|||
value: "*****************"
|
||||
- name: scopes # required.
|
||||
value: "<project-scopes>"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
|
||||
{{% /alert %}}
|
||||
|
@ -51,7 +48,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `clientID` | Y | Output | The commercetools client ID for the project | |
|
||||
| `clientSecret` | Y | Output | The commercetools client secret for the project | |
|
||||
| `scopes` | Y | Output | The commercetools scopes for the project | `"manage_project:project-key"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
For more information see [commercetools - Creating an API Client](https://docs.commercetools.com/getting-started/create-api-client#create-an-api-client) and [commercetools - Regions](https://docs.commercetools.com/api/general-concepts#regions).
|
||||
|
||||
|
@ -61,7 +57,6 @@ This component supports **output binding** with the following operations:
|
|||
|
||||
- `create`
|
||||
|
||||
|
||||
## Related links
|
||||
|
||||
- [Basic schema for a Dapr component]({{< ref component-schema >}})
|
||||
|
|
|
@ -11,7 +11,6 @@ aliases:
|
|||
|
||||
To setup Azure Cosmos DB binding create a component of type `bindings.azure.cosmosdb`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
|
||||
|
||||
|
||||
```yaml
|
||||
apiVersion: dapr.io/v1alpha1
|
||||
kind: Component
|
||||
|
@ -31,8 +30,6 @@ spec:
|
|||
value: "Orders"
|
||||
- name: partitionKey
|
||||
value: "<message>"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -48,7 +45,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `database` | Y | Output | The name of the Cosmos DB database | `"OrderDb"` |
|
||||
| `collection` | Y | Output | The name of the container inside the database. | `"Orders"` |
|
||||
| `partitionKey` | Y | Output | The name of the key to extract from the payload (document to be created) that is used as the partition key. This name must match the partition key specified upon creation of the Cosmos DB container. | `"OrderId"`, `"message"` |
|
||||
| `direction` | N | Output | The direction of the binding. | `"output"` |
|
||||
|
||||
For more information see [Azure Cosmos DB resource model](https://docs.microsoft.com/azure/cosmos-db/account-databases-containers-items).
|
||||
|
||||
|
|
|
@ -9,7 +9,6 @@ description: "Detailed documentation on the Azure Cosmos DB (Gremlin API) bindin
|
|||
|
||||
To setup an Azure Cosmos DB (Gremlin API) binding create a component of type `bindings.azure.cosmosdb.gremlinapi`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
|
||||
|
||||
|
||||
```yaml
|
||||
apiVersion: dapr.io/v1alpha1
|
||||
kind: Component
|
||||
|
@ -25,8 +24,6 @@ spec:
|
|||
value: "*****"
|
||||
- name: username
|
||||
value: "*****"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -40,7 +37,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `url` | Y | Output | The Cosmos DB url for Gremlin APIs | `"wss://******.gremlin.cosmos.azure.com:443/"` |
|
||||
| `masterKey` | Y | Output | The Cosmos DB account master key | `"masterKey"` |
|
||||
| `username` | Y | Output | The username of the Cosmos DB database | `"/dbs/<database_name>/colls/<graph_name>"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
For more information see [Quickstart: Azure Cosmos Graph DB using Gremlin](https://docs.microsoft.com/azure/cosmos-db/graph/create-graph-console).
|
||||
|
||||
|
|
|
@ -32,8 +32,6 @@ spec:
|
|||
value: "*****************"
|
||||
- name: sessionToken
|
||||
value: "*****************"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -49,7 +47,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `accessKey` | Y | Output | The AWS Access Key to access this resource | `"key"` |
|
||||
| `secretKey` | Y | Output | The AWS Secret Access Key to access this resource | `"secretAccessKey"` |
|
||||
| `sessionToken` | N | Output | The AWS session token to use | `"sessionToken"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
{{% alert title="Important" color="warning" %}}
|
||||
When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you're using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you **must not** provide AWS access-key, secret-key, and tokens in the definition of the component spec you're using.
|
||||
|
|
|
@ -47,8 +47,6 @@ spec:
|
|||
value: "<bool>"
|
||||
- name: encodeBase64
|
||||
value: "<bool>"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -72,7 +70,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `client_x509_cert_url` | Y | Output | GCP credentials project x509 cert url | `https://www.googleapis.com/robot/v1/metadata/x509/<PROJECT_NAME>.iam.gserviceaccount.com`
|
||||
| `decodeBase64` | N | Output | Configuration to decode base64 file content before saving to bucket storage. (In case of saving a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `true`, `false` |
|
||||
| `encodeBase64` | N | Output | Configuration to encode base64 file content before return the content. (In case of opening a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `true`, `false` |
|
||||
| `direction` | N | Output | The direction of the binding. | `"output"`
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -27,8 +27,6 @@ spec:
|
|||
value: "adminkey"
|
||||
- name: header:Cache-Control
|
||||
value: "no-cache"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -42,7 +40,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `endpoint` | Y | Output | GraphQL endpoint string See [here](#url-format) for more details | `"http://localhost:4000/graphql/graphql"` |
|
||||
| `header:[HEADERKEY]` | N | Output | GraphQL header. Specify the header key in the `name`, and the header value in the `value`. | `"no-cache"` (see above) |
|
||||
| `variable:[VARIABLEKEY]` | N | Output | GraphQL query variable. Specify the variable name in the `name`, and the variable value in the `value`. | `"123"` (see below) |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
### Endpoint and Header format
|
||||
|
||||
|
|
|
@ -40,8 +40,6 @@ spec:
|
|||
# key: "mytoken"
|
||||
#- name: securityTokenHeader
|
||||
# value: "Authorization: Bearer" # OPTIONAL <header name for the security token>
|
||||
#- name: direction
|
||||
# value: "output"
|
||||
```
|
||||
|
||||
## Spec metadata fields
|
||||
|
@ -56,7 +54,6 @@ spec:
|
|||
| `MTLSRenegotiation` | N | Output | Type of mTLS renegotiation to be used | `RenegotiateOnceAsClient`
|
||||
| `securityToken` | N | Output | The value of a token to be added to a HTTP request as a header. Used together with `securityTokenHeader` |
|
||||
| `securityTokenHeader` | N | Output | The name of the header for `securityToken` on a HTTP request |
|
||||
| `direction` | N | Output |The direction of the binding | `"output"`
|
||||
|
||||
### How to configure mTLS-related fields in metadata
|
||||
|
||||
|
|
|
@ -30,8 +30,6 @@ spec:
|
|||
# optional fields
|
||||
- name: region
|
||||
value: "<your-bucket-region>"
|
||||
- name: direction
|
||||
value: "<your-binding-direction>"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -47,7 +45,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `accessKey` | Y | Output | The Huawei Access Key (AK) to access this resource | `"************"` |
|
||||
| `secretKey` | Y | Output | The Huawei Secret Key (SK) to access this resource | `"************"` |
|
||||
| `region` | N | Output | The specific Huawei region of the bucket | `"cn-north-4"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -29,8 +29,6 @@ spec:
|
|||
value: "<ORG>"
|
||||
- name: bucket # Required
|
||||
value: "<BUCKET>"
|
||||
- name: direction
|
||||
value: "<DIRECTION>"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -45,7 +43,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `token` | Y | Output | The authorization token for InfluxDB | `"mytoken"` |
|
||||
| `org` | Y | Output | The InfluxDB organization | `"myorg"` |
|
||||
| `bucket` | Y | Output | Bucket name to write to | `"mybucket"` |
|
||||
| `direction` | N | Output | Direction of the binding | `"output"` |
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -34,13 +34,12 @@ spec:
|
|||
value: "echo"
|
||||
- name: version
|
||||
value: "0.5.0"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
## Spec metadata fields
|
||||
|
||||
The `InvokeRequest.Metadata` for `bindings.kitex` requires the client to fill in four required items when making a call:
|
||||
|
||||
- `hostPorts`
|
||||
- `destService`
|
||||
- `methodName`
|
||||
|
@ -52,8 +51,6 @@ The `InvokeRequest.Metadata` for `bindings.kitex` requires the client to fill in
|
|||
| `destService` | Y | Output | Service name of the Kitex server (Thrift) | `"echo"` |
|
||||
| `methodName` | Y | Output | Method name under a specific service name of the Kitex server (Thrift) | `"echo"` |
|
||||
| `version` | Y | Output | Kitex version | `"0.5.0"` |
|
||||
| `direction` | N | Output | Direction of the binding | `"output"` |
|
||||
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -23,16 +23,13 @@ spec:
|
|||
metadata:
|
||||
- name: rootPath
|
||||
value: "<string>"
|
||||
- name: direction
|
||||
value: "<direction>"
|
||||
```
|
||||
|
||||
## Spec metadata fields
|
||||
|
||||
| Field | Required | Binding support | Details | Example |
|
||||
|--------------------|:--------:|--------|---------|---------|
|
||||
| `rootPath` | Y | Input / Output | The root path anchor to which files can be read / saved | `"/temp/files"` |
|
||||
| `direction` | N | Input / Output | The direction of the binding | `"output"` |
|
||||
| `rootPath` | Y | Output | The root path anchor to which files can be read / saved | `"/temp/files"` |
|
||||
|
||||
## Binding support
|
||||
|
||||
|
@ -265,6 +262,5 @@ By default the Local Storage output binding auto generates a UUID as the file na
|
|||
|
||||
- [Basic schema for a Dapr component]({{< ref component-schema >}})
|
||||
- [Bindings building block]({{< ref bindings >}})
|
||||
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
|
||||
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
|
||||
- [Bindings API reference]({{< ref bindings_api.md >}})
|
||||
|
|
|
@ -36,8 +36,6 @@ spec:
|
|||
value: "<CONNECTION_MAX_LIFE_TIME>"
|
||||
- name: connMaxIdleTime
|
||||
value: "<CONNECTION_MAX_IDLE_TIME>"
|
||||
- name: direction
|
||||
value: "<DIRECTION_OF_BINDING>"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -55,7 +53,6 @@ Note that you can not use secret just for username/password. If you use secret,
|
|||
| `maxOpenConns` | N | Output | The max open connections. Integer greater than 0 | `"10"` |
|
||||
| `connMaxLifetime` | N | Output | The max connection lifetime. Duration string | `"12s"` |
|
||||
| `connMaxIdleTime` | N | Output | The max connection idel time. Duration string | `"12s"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
### SSL connection
|
||||
|
||||
|
@ -192,6 +189,5 @@ The `close` operation can be used to explicitly close the DB connection and retu
|
|||
|
||||
- [Basic schema for a Dapr component]({{< ref component-schema >}})
|
||||
- [Bindings building block]({{< ref bindings >}})
|
||||
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
|
||||
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
|
||||
- [Bindings API reference]({{< ref bindings_api.md >}})
|
||||
|
|
|
@ -25,8 +25,6 @@ spec:
|
|||
# Connection string
|
||||
- name: connectionString
|
||||
value: "<CONNECTION STRING>"
|
||||
- name: direction
|
||||
value: "<DIRECTION_OF_BINDING>"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
|
|
@ -30,8 +30,6 @@ spec:
|
|||
value: "dave@dapr.io" # optional
|
||||
- name: subject
|
||||
value: "Hello!" # optional
|
||||
- name: direction
|
||||
value: "output" # optional
|
||||
```
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
|
||||
|
@ -48,7 +46,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `emailCc` | N | Output | If set this specifies the 'cc' email address of the email message | `"me@example.com"` |
|
||||
| `emailBcc` | N | Output | If set this specifies the 'bcc' email address of the email message | `"me@example.com"` |
|
||||
| `subject` | N | Output | If set this specifies the subject of the email message | `"me@example.com"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
You can specify any of the optional metadata properties on the output binding request too (e.g. `emailFrom`, `emailTo`, `subject`, etc.)
|
||||
|
||||
|
|
|
@ -27,8 +27,6 @@ spec:
|
|||
value: "**************"
|
||||
- name: enableTLS
|
||||
value: "<bool>"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -61,7 +59,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `minIdleConns` | N | Output | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"`
|
||||
| `idleCheckFrequency` | N | Output | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"`
|
||||
| `idleTimeout` | N | Output | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"`
|
||||
| `direction` | N | Output | Direction of the binding. | `"output"`
|
||||
|
||||
## Binding support
|
||||
|
||||
|
@ -226,6 +223,5 @@ The Dapr CLI automatically deploys a local redis instance in self hosted mode as
|
|||
|
||||
- [Basic schema for a Dapr component]({{< ref component-schema >}})
|
||||
- [Bindings building block]({{< ref bindings >}})
|
||||
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
|
||||
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
|
||||
- [Bindings API reference]({{< ref bindings_api.md >}})
|
||||
|
|
|
@ -44,8 +44,6 @@ spec:
|
|||
value: "<bool>"
|
||||
- name: insecureSSL
|
||||
value: "<bool>"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -67,7 +65,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `encodeBase64` | N | Output | Configuration to encode base64 file content before return the content. (In case of opening a file with binary content). `"true"` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `"false"` | `"true"`, `"false"` |
|
||||
| `disableSSL` | N | Output | Allows to connect to non `https://` endpoints. Defaults to `"false"` | `"true"`, `"false"` |
|
||||
| `insecureSSL` | N | Output | When connecting to `https://` endpoints, accepts invalid or self-signed certificates. Defaults to `"false"` | `"true"`, `"false"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
{{% alert title="Important" color="warning" %}}
|
||||
When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you're using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you **must not** provide AWS access-key, secret-key, and tokens in the definition of the component spec you're using.
|
||||
|
|
|
@ -41,8 +41,6 @@ spec:
|
|||
value: '{"customer":{"name":"John Smith"}}' # optional
|
||||
- name: apiKey
|
||||
value: "YOUR_API_KEY" # required, this is your SendGrid key
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -61,7 +59,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `emailCc` | N | Output | If set this specifies the 'cc' email address of the email message. Only a single email address is allowed. Optional field, see [below](#example-request-payload) | `"me@example.com"` |
|
||||
| `emailBcc` | N | Output | If set this specifies the 'bcc' email address of the email message. Only a single email address is allowed. Optional field, see [below](#example-request-payload) | `"me@example.com"` |
|
||||
| `subject` | N | Output | If set this specifies the subject of the email message. Optional field, see [below](#example-request-payload) | `"subject of the email"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -40,8 +40,6 @@ spec:
|
|||
value: "bcc@example.com"
|
||||
- name: subject
|
||||
value: "subject"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -61,7 +59,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `emailCc` | N | Output | If set, this specifies the email address to CC in. See [also](#example-request) | `"me@example.com"` |
|
||||
| `emailBcc` | N | Output | If set, this specifies email address to BCC in. See [also](#example-request) | `"me@example.com"` |
|
||||
| `subject` | N | Output | If set, this specifies the subject of the email message. See [also](#example-request) | `"subject of mail"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
{{% alert title="Important" color="warning" %}}
|
||||
When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you're using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you **must not** provide AWS access-key, secret-key, and tokens in the definition of the component spec you're using.
|
||||
|
|
|
@ -25,8 +25,6 @@ spec:
|
|||
value: "Endpoint=https://<your-azure-signalr>.service.signalr.net;AccessKey=<your-access-key>;Version=1.0;"
|
||||
- name: hub # Optional
|
||||
value: "<hub name>"
|
||||
- name: direction
|
||||
value: "<direction of binding>"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -41,7 +39,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `hub` | N | Output | Defines the hub in which the message will be send. The hub can be dynamically defined as a metadata value when publishing to an output binding (key is "hub") | `"myhub"` |
|
||||
| `endpoint` | N | Output | Endpoint of Azure SignalR; required if not included in the `connectionString` or if using Azure AD | `"https://<your-azure-signalr>.service.signalr.net"`
|
||||
| `accessKey` | N | Output | Access key | `"your-access-key"`
|
||||
| `direction` | N | Output | The direction of the binding | `"output"`
|
||||
|
||||
### Azure Active Directory (Azure AD) authentication
|
||||
|
||||
|
|
|
@ -43,8 +43,6 @@ spec:
|
|||
value: "subject"
|
||||
- name: priority
|
||||
value: "[value 1-5]"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -66,7 +64,6 @@ The example configuration shown above, contain a username and password as plain-
|
|||
| `emailBcc` | N | Output | If set, this specifies email address to BCC in. See [also](#example-request) | `"me@example.com"` |
|
||||
| `subject` | N | Output | If set, this specifies the subject of the email message. See [also](#example-request) | `"subject of mail"` |
|
||||
| `priority` | N | Output | If set, this specifies the priority (X-Priority) of the email message, from 1 (lowest) to 5 (highest) (default value: 3). See [also](#example-request) | `"1"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -32,8 +32,6 @@ spec:
|
|||
value: "*****************"
|
||||
- name: sessionToken
|
||||
value: "*****************"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
@ -49,7 +47,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `accessKey` | Y | Output | The AWS Access Key to access this resource | `"key"` |
|
||||
| `secretKey` | Y | Output | The AWS Secret Access Key to access this resource | `"secretAccessKey"` |
|
||||
| `sessionToken` | N | Output | The AWS session token to use | `"sessionToken"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
{{% alert title="Important" color="warning" %}}
|
||||
When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you're using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you **must not** provide AWS access-key, secret-key, and tokens in the definition of the component spec you're using.
|
||||
|
|
|
@ -11,8 +11,6 @@ aliases:
|
|||
|
||||
To setup Twilio SMS binding create a component of type `bindings.twilio.sms`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
apiVersion: dapr.io/v1alpha1
|
||||
kind: Component
|
||||
|
@ -30,8 +28,6 @@ spec:
|
|||
value: "*****************"
|
||||
- name: authToken # required.
|
||||
value: "*****************"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
|
||||
|
@ -45,7 +41,6 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| `fromNumber` | Y | Output | The sender phone number | `"222-222-2222"` |
|
||||
| `accountSid` | Y | Output | The Twilio account SID | `"account sid"` |
|
||||
| `authToken` | Y | Output | The Twilio auth token | `"auth token"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -71,18 +71,15 @@ spec:
|
|||
type: bindings.wasm
|
||||
version: v1
|
||||
metadata:
|
||||
- name: url
|
||||
value: "file://uppercase.wasm"
|
||||
- name: direction
|
||||
value: "output"
|
||||
- name: url
|
||||
value: "file://uppercase.wasm"
|
||||
```
|
||||
|
||||
## Spec metadata fields
|
||||
|
||||
| Field | Details | Required | Example |
|
||||
|-------|----------------------------------------------------------------|----------|----------------|
|
||||
| url | The URL of the resource including the Wasm binary to instantiate. The supported schemes include `file://`, `http://`, and `https://`. The path of a `file://` URL is relative to the Dapr process unless it begins with `/`. | true | `file://hello.wasm`, `https://example.com/hello.wasm` |
|
||||
| `direction` | The direction of the binding | false | `"output"` |
|
||||
| `url` | The URL of the resource including the Wasm binary to instantiate. The supported schemes include `file://`, `http://`, and `https://`. The path of a `file://` URL is relative to the Dapr process unless it begins with `/`. | true | `file://hello.wasm`, `https://example.com/hello.wasm` |
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -28,8 +28,6 @@ spec:
|
|||
value: "true"
|
||||
- name: caCertificatePath
|
||||
value: "/path/to/ca-cert"
|
||||
- name: direction
|
||||
value: "output"
|
||||
```
|
||||
|
||||
## Spec metadata fields
|
||||
|
@ -40,7 +38,6 @@ spec:
|
|||
| `gatewayKeepAlive` | N | Output | Sets how often keep alive messages should be sent to the gateway. Defaults to 45 seconds | `"45s"` |
|
||||
| `usePlainTextConnection` | N | Output | Whether to use a plain text connection or not | `"true"`, `"false"` |
|
||||
| `caCertificatePath` | N | Output | The path to the CA cert | `"/path/to/ca-cert"` |
|
||||
| `direction` | N | Output | The direction of the binding | `"output"` |
|
||||
|
||||
## Binding support
|
||||
|
||||
|
|
|
@ -47,10 +47,10 @@ spec:
|
|||
- name: fetchVariables
|
||||
value: "productId, productName, productKey"
|
||||
- name: autocomplete
|
||||
value: "true"
|
||||
value: "true"
|
||||
- name: retryBackOff
|
||||
value: "30s"
|
||||
- name: direction
|
||||
value: "30s"
|
||||
- name: direction
|
||||
value: "input"
|
||||
```
|
||||
|
||||
|
|
Loading…
Reference in New Issue