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.

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

[dubbo] component spec #3438

Closed
wants to merge 10 commits into from
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
type: docs
title: "Alibaba Cloud Dubbo output binding spec"
linkTitle: "Alibaba Cloud Dubbo"
description: "Detailed documentation on the Alibaba Cloud Dubbo output binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/dubbo/"
---

## Component format

To setup an Alibaba Cloud Dubbo binding create a component of type `bindings.alicloud.dubbo`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.

See [this](https://dubbo.apache.org/docs/) for the documentation for Alibaba Cloud Dubbo.

```yml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: alicloud-dubbo-binding
namespace: default
spec:
type: bindings.alicloud.dubbo
hhunter-ms marked this conversation as resolved.
Show resolved Hide resolved
version: v1
metadata:
- name: group
value: ""
- name: version
value: ""
- name: interfaceName
value: ""
- name: methodName
value: ""
- name: providerHostname
value: ""
- name: providerPort
value: ""
```

{{% 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 %}}

## Spec metadata fields

| Field | Required | Binding support | Details | Example |
|--------------------|:--------:|------------|-----|---------|
| `group` | N | Output | | `""` |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need examples and defaults here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

| `version` | N | Output | | `""` |
| `interfaceName` | N | Input | | `""` |
| `methodName` | N | Input | | `""` |
| `providerHostname` | N | Input | | `""` |
| `providerPort` | N | Output | | `""` |

## Related links

- [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 >}})
8 changes: 8 additions & 0 deletions daprdocs/data/components/bindings/alibaba.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@
features:
input: true
output: true
- component: Alibaba Cloud Dubbo
link: alicloud-dubbo
state: Stable
version: v1
since: "1.8"
features:
input: false
output: true
- component: Alibaba Cloud OSS
link: alicloudoss
state: Alpha
Expand Down