dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove Nacos and RocketMQ (#1511) 

* Remove RocketMQ and Nacos

* Update dependencies
This commit is contained in:
Aaron Crawfis 2021-05-24 20:26:52 -07:00 committed by GitHub
parent 43a0e2d8e2
commit 5a897cad24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 1427 additions and 648 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
daprdocs/content/en/reference/components-reference/supported-bindings/_index.md
View File

@ -48,9 +48,7 @@ Table captions:
| Name | Input<br>Binding | Output<br>Binding | Status | Component version | Since |
|------|:----------------:|:-----------------:|--------| ------ |----------|
| [Alibaba Cloud DingTalk]({{< ref alicloud-dingtalk.md >}}) | ✅ | ✅ | Alpha | v1 | 1.2 |
| [Alibaba Cloud Nacos]({{< ref alicloud-nacos.md >}}) | ✅ | ✅ | Alpha | v1 | 1.2 |
| [Alibaba Cloud OSS]({{< ref alicloudoss.md >}}) | | ✅ | Alpha | v1 | 1.0 |
| [Alibaba Cloud RocketMQ]({{< ref alicloud-rocketmq.md >}}) | ✅ | ✅ | Alpha | v1 | 1.2 |
### Amazon Web Services (AWS)

113
daprdocs/content/en/reference/components-reference/supported-bindings/alicloud-nacos.md
View File

@ -1,113 +0,0 @@
---
type: docs
title: "Alibaba Cloud Nacos binding spec"
linkTitle: "Alibaba Cloud Nacos"
description: "Detailed documentation on the Alibaba Cloud Nacos binding component"
---
## Setup Dapr component
To setup an Alibaba Cloud Nacos binding create a component of type `bindings.nacos`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: bindings.nacos
version: v1
metadata:
- name: endpoint
value: "******.mse.aliyuncs.com:8848"
- name: region
value: "cn-shanghai"
- name: namespace
value: "e525eafa-f7d7-4029-83d9-************"
- name: accessKey
value: "****************"
- name: secretKey
value: "****************"
- name: watches
value: "key1:group1,key2:group2"
```
{{% 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 |
|--------------------|:--------:|--------|--------|---------|
| endpoint | Y | Input/Output |the endpoint to get Nacos server addresses | `"******.mse.aliyuncs.com:8848"`
| region | Y | Input/Output |the regionId for kms | `"cn-shanghai"`
| namespace | Y | Input/Output |the namespaceId of Nacos | `"e525eafa-f7d7-4029-83d9-************"`
| config | Y | Output |A comma separated string of key | `"key1:group1"`
| accessKey | N | Input/Output |the AccessKey for kms| `"****************"`
| secretKey | N | Input/Output |the SecretKey for kms | `"****************"`
| timeout | N | Input/Output |timeout for requesting Nacos server, default value is 10000 ms | `1000`
| cacheDir | N | Input/Output |the directory for persist Nacos service info,default value is current path | `"/tmp/nacos/cache"`
| updateThreadNum | N | Input/Output |the number of gorutine for update Nacos service info,default value is 20 | `20`
| notLoadCacheAtStart | N | Input/Output |not to load persistent Nacos service info in CacheDir at start time | `"false"`
| updateCacheWhenEmpty | N | Input/Output |update cache when get empty service instance from server | `"false"`
| username | N | Input/Output |the password for Nacos auth | `"username"`
| password | N | Input/Output |the password for Nacos auth | `"password"`
| logDir | N | Input/Output |the directory for log, default is current path | `"/tmp/nacos/log"`
| rotateTime | N | Input/Output |the rotate time for log, eg: 30m, 1h, 24h, default is 24h| `"1h"`
| maxAge | N | Input/Output |the max age of a log file, default value is 3 | `3`
| logLevel | N | Input/Output |the level of log, it's must be debug,info,warn,error, default value is info | `"info"`
| watches | N | Input |A comma separated string of watch keys | `"key1:group1,key2:group2"`
## Binding support
This component supports both **input and output** binding interfaces.
This component supports **output binding** with the following operations:
- `create`
- `get`
## Create an AliCloud Nacos
Follow [these instructions](https://www.alibabacloud.com/help/doc-detail/59963.htm) to setup AliCloud Nacos.
- A Chinese (simplified) version can be found [here](https://help.aliyun.com/document_detail/85466.html)
## Specifying a partition key
When invoking the Nacos binding, its possible to provide an optional partition key by using the `metadata` section in the request body.
You can specifie`config-id` and `config-group` in `metadata`
Example:
```shell
curl -X POST http://localhost:3500/v1.0/bindings/myNacos \
-H "Content-Type: application/json" \
-d '{
"data": {
"message": "Hi"
},
"metadata": {
"config-id": "key1",
"config-group": "group1"
},
"operation": "create"
}'
```
```shell
curl -X POST http://localhost:3500/v1.0/bindings/myNacos \
-H "Content-Type: application/json" \
-d '{
"data": {
"message": "Hi"
},
"metadata": {
"config-id": "key1",
"config-group": "group1"
},
"operation": "get"
}'
```
## 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 >}})

123
daprdocs/content/en/reference/components-reference/supported-bindings/alicloud-rocketmq.md
View File

@ -1,123 +0,0 @@
---
type: docs
title: "Alibaba Cloud RocketMQ binding spec"
linkTitle: "Alibaba Cloud RocketMQ"
description: "Detailed documentation on the Alibaba Cloud RocketMQ binding component"
---
## Setup Dapr component
To setup an Alibaba Cloud Object Storage binding create a component of type `bindings.rocketmq`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
### HTTP
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: bindings.rocketmq
version: v1
metadata:
- name: accessProto
value: "http"
- name: endpoint
value: "http://********.cn-qingdao-public.aliyuncs.com"
- name: accessKey
value: "****************"
- name: secretKey
value: "****************"
- name: consumerGroup
value: "GID_******"
- name: instanceId
value: "MQ_INST_******"
- name: topics
value: "topic1||topic2"
```
### TCP
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: bindings.rocketmq
version: v1
metadata:
- name: accessProto
value: "tcp"
- name: nameServer
value: "http://*************.aliyuncs.com:80"
- name: accessKey
value: "****************"
- name: secretKey
value: "****************"
- name: consumerGroup
value: "GID_******"
- name: instanceId
value: "MQ_INST_******"
- name: topics
value: "topic1||topic2"
```
{{% 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 |
|--------------------|:--------:|--------|--------|---------|
| nameServer | N | Input/Output |RocketMQ's name server, optional| `"http://*************.aliyuncs.com:80"`
| endpoint | N | Input/Output |RocketMQ's endpoint, optional, just for HTTP proto | `"http://********.cn-qingdao-public.aliyuncs.com"`
| accessProto | Y | Input/Output |sdk proto (HTTP or TCP),default TCP| `"tcp"`
| accessKey | N | Input/Output |RocketMQ Credentials| `"****************"`
| secretKey | N | Input/Output |RocketMQ Credentials | `"****************"`
| consumerGroup | N | Input |consumer group for RocketMQ's subscribers, suggested to provide | `"GID_******"`
| consumerBatchSize | N | Input |consumer group for RocketMQ's subscribers, suggested to provide, just for http proto | `1024`
| consumerThreadNums | N | Input |consumer group for RocketMQ's subscribers, suggested to provide, just for cgo proto | `20`
| instanceId | N | Input/Output |RocketMQ's namespace, optional | `"MQ_INST_******"`
| nameServerDomain | N | Input/Output |RocketMQ's name server domain, optional| `"http://*************.aliyuncs.com"`
| retries | N | Input/Output |retry times to connect RocketMQ's broker, optional | `0`
| topics | Y | Input/Output | topics to subscribe, use delimiter double vertical bar to separate if more than one topics are configured | `"topic1"`
## Binding support
This component supports both **input and output** binding interfaces.
This component supports **output binding** with the following operations:
- `create`
## Create an AliCloud RocketMQ
Follow the instructions [here](https://www.alibabacloud.com/help/doc-detail/200153.htm) to setup AliCloud RocketMQ
- Simplified Chinese version [here](https://help.aliyun.com/document_detail/200153.html)
## Specifying a partition key
When invoking the rocketmq binding, its possible to provide an optional partition key by using the `metadata` section in the request body.
You can specifie`rocketmq-topic`,`rocketmq-tag`,`"rocketmq-key"` in `metadata`
Example:
```shell
curl -X POST http://localhost:3500/v1.0/bindings/myRocketMQ \
-H "Content-Type: application/json" \
-d '{
"data": {
"message": "Hi"
},
"metadata": {
"rocketmq-topic": "topic1",
"rocketmq-tag": "tag",
"rocketmq-key": "key1",
},
"operation": "create"
}'
```
## 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 >}})

5
daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md
View File

@ -30,11 +30,6 @@ Table captions:
| [RabbitMQ]({{< ref setup-rabbitmq.md >}}) | Alpha | v1 | 1.0 |
| [Redis Streams]({{< ref setup-redis-pubsub.md >}}) | GA | v1 | 1.0 |
### Alibaba Cloud
| Name | Status | Component version | Since |
|---------------------------------------------------|--------| ---- |---------------|
| [Alibaba Cloud RocketMQ]({{< ref setup-alicloud-rocketmq.md >}}) | Alpha | v1 | 1.2 |
### Amazon Web Services (AWS)
| Name | Status | Component version | Since |

108
daprdocs/content/en/reference/components-reference/supported-pubsub/setup-alicloud-rocketmq.md
View File

@ -1,108 +0,0 @@
---
type: docs
title: "Alibaba Cloud RocketMQ"
linkTitle: "Alibaba Cloud RocketMQ"
description: "Detailed documentation on the Alibaba Cloud RocketMQ pubsub component"
---
## Component format
To setup Alibaba Cloud RocketMQ pubsub create a component of type `pubsub.rocketmq`. See [this guide]({{< ref "howto-publish-subscribe.md#step-1-setup-the-pubsub-component" >}}) on how to create and apply a pubsub configuration.
### HTTP
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: pubsub.rocketmq
version: v1
metadata:
- name: accessProto
value: "http"
- name: endpoint
value: "http://********.cn-qingdao-public.aliyuncs.com"
- name: accessKey
value: "****************"
- name: secretKey
value: "****************"
- name: consumerGroup
value: "GID_******"
- name: instanceId
value: "MQ_INST_******"
```
### TCP
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: pubsub.rocketmq
version: v1
metadata:
- name: accessProto
value: "tcp"
- name: nameServer
value: "http://*************.aliyuncs.com:80"
- name: accessKey
value: "****************"
- name: secretKey
value: "****************"
- name: consumerGroup
value: "GID_******"
- name: instanceId
value: "MQ_INST_******"
```
{{% 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 | Details | Example |
|--------------------|:--------:|--------|---------|
| nameServer | N | RocketMQ's name server, optional| `"http://*************.aliyuncs.com:80"`
| endpoint | Y | RocketMQ's endpoint, optional, just for HTTP proto | `"http://********.cn-qingdao-public.aliyuncs.com"`
| accessProto | Y |sdk proto (HTTP or TCP),default TCP| `"tcp"`
| accessKey | N | RocketMQ Credentials| `"****************"`
| secretKey | N | RocketMQ Credentials | `"****************"`
| consumerGroup | N | consumer group for RocketMQ's subscribers, suggested to provide | `"GID_******"`
| consumerBatchSize | N | consumer group for RocketMQ's subscribers, suggested to provide, just for HTTP proto | `1024`
| consumerThreadNums | N |consumer group for RocketMQ's subscribers, suggested to provide, just for cgo proto | `20`
| instanceId | N | RocketMQ's namespace, optional | `"MQ_INST_******"`
| nameServerDomain | N |RocketMQ's name server domain, optional| `"mqrest.cn.aliyuncs.com"`
| retries | N | retry times to connect rocketmq's broker, optional | `0`
| content-type | N | msg's content-type eg:"application/cloudevents+json; charset=utf-8", application/octet-stream | `"text/plain"`
## Create an AliCloud RocketMQ
Follow the instructions [here](https://www.alibabacloud.com/help/doc-detail/200153.htm) to setup AliCloud RocketMQ
- Simplified Chinese translation [here](https://help.aliyun.com/document_detail/200153.html)
## Per-call metadata fields
### Partition Key
When invoking the rocketmq pub/sub, its possible to provide an optional partition key by using the `metadata` query param in the request url.
You need specifie `rocketmq-tag`,`"rocketmq-key"` in `metadata`
Example:
```shell
curl -X POST http://localhost:3500/v1.0/publish/myRocketMQ/myTopic?metadata.rocketmq-tag=?&metadata.rocketmq-key=? \
-H "Content-Type: application/json" \
-d '{
"data": {
"message": "Hi"
}
}'
```
## Related links
- [Basic schema for a Dapr component]({{< ref component-schema >}})
- [Pub/Sub building block]({{< ref pubsub >}})
- Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components

1715
daprdocs/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

9
daprdocs/package.json
View File

@ -12,9 +12,12 @@
"url": "https://github.com/dapr/docs/issues"
},
"homepage": "https://dapr.io",
"dependencies": {},
"devDependencies": {
"autoprefixer": "^9.8.6",
"postcss-cli": "^7.1.2"
"autoprefixer": "^10.2.5",
"postcss-cli": "^8.3.1"
},
"dependencies": {
"autoprefixer": "^10.2.5",
"postcss": "^8.3.0"
}
}