-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add readme for sink-tencent-scf and source-tencent-cos (#91)
- Loading branch information
1 parent
07a0cc4
commit de28653
Showing
9 changed files
with
418 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,195 @@ | ||
# Tencent SCF Sink Connector | ||
|
||
## Introduction | ||
|
||
This connector for invoking SCF function with events. | ||
|
||
## Quickstart | ||
|
||
### create config file | ||
|
||
```shell | ||
cat << EOF > config.yml | ||
v_port: 8080 | ||
function: | ||
name: "xxxxxxxxx" | ||
region: "ap-beijing" | ||
namespace: "default" | ||
EOF | ||
``` | ||
|
||
For full configuration, you can see [config](#config) section. | ||
|
||
### create secret file | ||
|
||
```shell | ||
cat << EOF > secret.yml | ||
secret_id: "xxxx" | ||
secret_key: "xxxxx" | ||
EOF | ||
``` | ||
|
||
### start | ||
|
||
```shell | ||
docker run -d --rm \ | ||
--network host \ | ||
-v ${PWD}:/vance/config \ | ||
-v ${PWD}:/vance/secret \ | ||
--name sink-tencentcloud-scf public.ecr.aws/vanus/connector/sink-tencentcloud-scf:dev | ||
``` | ||
|
||
### send an event to sink | ||
|
||
```bash | ||
curl --location --request POST 'localhost:8080' \ | ||
--header 'Content-Type: application/cloudevents+json' \ | ||
--data-raw '{ | ||
"id": "53d1c340-551a-11ed-96c7-8b504d95037c", | ||
"source": "local", | ||
"specversion": "1.0", | ||
"type": "xxxx", | ||
"datacontenttype": "application/json", | ||
"time": "2022-10-26T10:38:29.345Z", | ||
"data": { | ||
"Records": [ | ||
{ | ||
"cos": "xxxx" | ||
}, | ||
{ | ||
"cos": "yyy" | ||
} | ||
] | ||
} | ||
}' | ||
``` | ||
|
||
the `data` will be as payload to invoke function | ||
|
||
### see logs in SCF console | ||
|
||
![log.png](scf-log.png) | ||
|
||
### clean resource | ||
|
||
```shell | ||
docker stop sink-tencentcloud-scf | ||
``` | ||
|
||
## Configuration | ||
|
||
### config | ||
|
||
```yml | ||
v_port: 8080 | ||
function: | ||
name: "vanus-cos-source-function-3513950818025804220" | ||
region: "ap-beijing" | ||
namespace: "default" | ||
debug: false | ||
``` | ||
| Name | Required | Default | Description | | ||
|:-------------------|:--------:|:-------:|------------------------------------------| | ||
| v_port | No | 8080 | which port for listening | | ||
| function.region | **YES** | - | which region the function was created | | ||
| function.name | **YES** | - | function name will be invoked | | ||
| function.namespace | **YES** | - | which namespace the function was created | | ||
| debug | NO | false | if print debug log | | ||
### secret | ||
| Name | Required | Default | Description | | ||
|:-----------|:--------:|:-------:|----------------------------| | ||
| secret_id | **YES** | - | SecretID of Tencent Cloud | | ||
| secret_key | **YES** | - | SecretKey of Tencent Cloud | | ||
## Deploy | ||
### using k8s(recommended) | ||
```yml | ||
apiVersion: v1 | ||
kind: Service | ||
metadata: | ||
name: sink-tencentcloud-function | ||
namespace: vanus | ||
spec: | ||
selector: | ||
app: sink-tencentcloud-function | ||
type: NodePort | ||
ports: | ||
- port: 8080 | ||
targetPort: 8080 | ||
nodePort: 32555 | ||
name: sink-tencentcloud-function | ||
--- | ||
apiVersion: v1 | ||
kind: ConfigMap | ||
metadata: | ||
name: sink-tencentcloud-function | ||
namespace: vanus | ||
data: | ||
config.yml: |- | ||
v_port: 8080 | ||
function: | ||
name: "xxxxxx" | ||
region: "ap-beijing" | ||
namespace: "default" | ||
debug: false | ||
--- | ||
apiVersion: v1 | ||
kind: Secret | ||
metadata: | ||
name: sink-tencentcloud-function | ||
namespace: vanus | ||
type: Opaque | ||
data: | ||
# cat secret.yml | base64 | ||
secret.yml: | | ||
xxxxx | ||
immutable: true | ||
--- | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: sink-tencentcloud-function | ||
namespace: vanus | ||
labels: | ||
app: sink-tencentcloud-function | ||
spec: | ||
selector: | ||
matchLabels: | ||
app: sink-tencentcloud-function | ||
replicas: 1 | ||
template: | ||
metadata: | ||
labels: | ||
app: sink-tencentcloud-function | ||
spec: | ||
containers: | ||
- name: sink-tencentcloud-function | ||
image: public.ecr.aws/vanus/connector/sink-tencentcloud-function:dev | ||
imagePullPolicy: Always | ||
ports: | ||
- name: http | ||
containerPort: 8080 | ||
volumeMounts: | ||
- name: config | ||
mountPath: /vance/config | ||
- name: secret | ||
mountPath: /vance/secret | ||
volumes: | ||
- name: secret | ||
secret: | ||
secretName: sink-tencentcloud-function | ||
- name: config | ||
configMap: | ||
name: sink-tencentcloud-function | ||
``` | ||
### using vance Operator | ||
coming soon |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
Oops, something went wrong.