Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serverless-components/tencent-scf
Deploy Tencent Cloud Serverless Cloud Function in seconds with Serverless Components.
https://github.com/serverless-components/tencent-scf
cloud cloud-function serverless serverless-framework tencent tencent-cloud
Last synced: about 2 months ago
JSON representation
Deploy Tencent Cloud Serverless Cloud Function in seconds with Serverless Components.
- Host: GitHub
- URL: https://github.com/serverless-components/tencent-scf
- Owner: serverless-components
- License: mit
- Created: 2019-10-17T01:44:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-05T10:18:08.000Z (over 2 years ago)
- Last Synced: 2024-10-31T16:37:31.737Z (about 2 months ago)
- Topics: cloud, cloud-function, serverless, serverless-framework, tencent, tencent-cloud
- Language: JavaScript
- Homepage: https://www.serverless.com
- Size: 515 KB
- Stars: 99
- Watchers: 10
- Forks: 30
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-serverless-framework - @serverless/tencent-scf - (组件)
README
[](http://serverless.com)
## 组件概述
**腾讯云 SCF 云函数组件**通过使用 [Tencent Serverless Framework](https://github.com/serverless/components/tree/cloud)，基于云上 Serverless 服务（云函数及触发器等），实现“0”配置，便捷开发，极速部署您的第一个云函数，该组件支持丰富的配置扩展，提供了目前最易用、低成本并且弹性伸缩的云函数的开发、配置及部署能力。
## 快速入门
### 前提条件
- 已安装 Serverless Framework（参考 [安装 Serverless Framework](https://cloud.tencent.com/document/product/1154/42990)）
- 账号开通 Serverless 相关权限（参考 [账号和权限配置](https://cloud.tencent.com/document/product/1154/43006)）
### 操作步骤
#### 创建
- 方式一：按照 [快速部署](https://cloud.tencent.com/document/product/1154/41775) 操作，选择 SCF 项目模板进行创建。
- 方式二：直接使用 `serverless init` 命令创建。快速创建一个 nodejs 的 SCF 示例：
```bash
$ serverless init scf-starter --name example
$ cd example
```
> **说明**：命令中的 `scf-starter` 可以更换成其他语言模板。目前 SCF 组件支持的模板有：`scf-golang`、`scf-nodejs`、`scf-php`、`scf-python`。
#### 部署
在 `serverless.yml` 文件所在的项目根目录，运行以下指令，将会弹出二维码，直接扫码授权进行部署:
```
serverless deploy
```
可以通过添加 inputs 参数设置预置并发，例如：为版本 1 设置 4 个预置并发(如果不指定版本会新发布一个版本，并为新版本设置并发)
```
serverless deploy --inputs provisionedNum=4 qualifier=1
```
> **说明**：如果鉴权失败，请参考 [权限配置](https://cloud.tencent.com/document/product/1154/43006) 进行授权。
#### 查看
执行以下命令，查看您部署的项目信息：
```
serverless info
```
#### 移除
执行以下命令，移除您已经部署的项目：
```
serverless remove
```
## 进阶指导
### serverless.yml
执行 `serverless deploy` 时，根据 serverless.yml 文件中的配置对云函数资源进行创建或更新。一份简单的 serverlesss.yml 文件如下：
> **说明**：配置详情请参考 [全量配置文档](https://github.com/serverless-components/tencent-scf/blob/master/docs/configure.md)。
```
component: scf # (必填) 引用 component 的名称，当前用到的是 tencent-scf 组件
name: scfdemo # (必填) 创建的实例名称，请修改成您的实例名称
#组件参数
inputs:
name: ${name}-${stage}-${app} #函数名称
src: ./ #代码路径
type: 'web' # 部署Web函数时需指定该值
handler: index.main_handler #入口（部署非Web函数时生效）
runtime: Nodejs10.15 # 云函数运行时的环境
region: ap-guangzhou # 云函数所在区域
events: # 触发器
- apigw: # 网关触发器
parameters:
endpoints:
- path: /
method: GET
```
serverless.yml 文件包含的信息：
#### 组件信息
| 组件名 | 是否必选 | 说明 |
| --------- | -------- | ----------------------------------------------------------------- |
| component | 必填 | component 的名称，使用`serverless registry`查询您可以引入的组件。 |
| name | 必填 | 创建的实例名称，每个组件在部署时将创建一个实例。 |
#### 参数信息
inputs 下的参数为组件配置参数。一个最简单 SCF 组件参数配置由以下几部分：
| 参数名 | 说明 |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| name | 云函数名称。由于云函数又是资源 ID，为了保证资源的唯一性，建议采用 `${name}-${stage}-${app}` 变量方式。 |
| src | 代码路径。 |
| type | 函数类型，默认为事件函数。支持的类型为：event（事件函数），web（Web 函数）。 |
| handler | 函数处理方法名称 。 |
| entryFile | 函数入口文件名。（函数类型为 web 且无 scf_bootstrap 文件时生效） |
| runtime | 云函数运行环境，目前支持： Python2.7、Python3.6、Nodejs6.10、Nodejs8.9、Nodejs10.15、Nodejs12.16、PHP5、PHP7、Go1、Java8 和 CustomRuntime。 |
| region | 云函数所在的区域。 |
| events | 触发器。 支持的触发器为：timer、apigw、cos、cmq、ckafka 。 |
### 账号权限
部署实例时需要账号授权去操作具体的云资源，目前可以通过两种方式进行授权：**扫码授权**和**密钥授权**。
- **扫码授权**：能快速进行授权部署，但生成的凭证是临时凭证，过期后需要重新扫码。
- **密钥授权**：能够获得永久授权，需要预先配置账号的 SecretId 和 SecretKey 。
配置详情可参考 [权限配置](https://cloud.tencent.com/document/product/1154/43006)。
### 开发调试
在 `serverless.yml`文件所在的目录下运行 `serverless dev` 可以实时输出云端日志，每次部署完毕后，对项目进行访问，即可在命令行中实时输出调用日志，便于查看业务情况和排障。nodejs 支持开启开发调试能力，将会对本地代码的改动进行检测和自动上传。详情请参考 [开发与调试](https://cloud.tencent.com/document/product/1154/43220)。
### 应用管理
Serverless 部署一个组件实例实质是部署了一个单组件实例的应用。
在应用项目开发过程中，一个应用下可能会存在多个组件实例，如何管理组件实例进行应用项目开发，请参考 [应用管理](https://cloud.tencent.com/document/product/1154/48261)。
## 其他命令
[其他命令](./docs/command.md)
## License
MIT License
Copyright (c) 2020 Tencent Cloud, Inc.