2005ccy / tencent-scf Goto Github PK

腾讯云 SCF 云函数组件 ⎯⎯⎯ 通过使用 Tencent Serverless Framework，基于云上 Serverless 服务（云函数及触发器等），实现“0”配置，便捷开发，极速部署你的第一个云函数，该组件支持丰富的配置扩展，提供了目前最易用、低成本并且弹性伸缩的云函数的开发、配置及部署能力。

特性介绍：

• 按需付费 - 按照请求的使用量进行收费，没有请求时无需付费
• "0"配置 - 只需要关心项目代码，之后部署即可，Serverless Framework 会搞定所有配置。
• 极速部署 - 仅需几秒，部署你的整个云函数应用。
• 实时日志 - 通过实时日志的输出查看业务状态，便于直接在云端开发应用。
• 云端调试 - 针对 Node.js 框架支持一键云端调试能力，屏蔽本地环境的差异。
• 便捷协作 - 通过云端的状态信息和部署日志，方便的进行多人协作开发。

快速开始：

1. 安装
2. 创建
3. 部署
4. 配置
5. 开发调试
6. 查看状态
7. 移除
8. 账号配置

通过 npm 安装最新版本的 Serverless Framework

$ npm install -g serverless

创建并进入一个全新目录：

$ mkdir tencent-scf && cd tencent-scf

通过如下命令和模板链接，快速创建一个 SCF 应用：

$ serverless create --template-url https://github.com/serverless-components/tencent-scf/tree/v2/example
$ cd example

下载完毕后，目录结构如下所示：

|- src
|   └── index.js
└──  serverless.yml

在 serverless.yml 文件下的目录中运行 serverless deploy 进行云函数的部署部署完毕后，你可以在命令行的输出中查看到对应云函数的网关触发器提供的 URL 地址，点击地址即可查看云函数的部署效果。

如您的账号未登陆或注册腾讯云，您可以直接通过微信扫描命令行中的二维码进行授权登陆和注册。

如果希望查看更多部署过程的信息，可以通过sls deploy --debug 命令查看部署过程中的实时日志信息，sls是 serverless 命令的缩写。

腾讯云 SCF 组件支持 0 配置部署，也就是可以直接通过配置文件中的默认值进行部署。但你依然可以修改更多可选配置来进一步开发该项目。

以下是腾讯云 SCF 组件的 serverless.yml完整配置说明：

# serverless.yml

component: scf # (必填) 引用 component 的名称，当前用到的是 tencent-scf 组件
name: scfdemo # (必填) 该组件创建的实例名称
org: test # (可选) 用于记录组织信息，默认值为您的腾讯云账户 appid
app: scfApp # (可选) 该 SCF 应用名称
stage: dev # (可选) 用于区分环境信息，默认值是 dev

inputs:
  name: scfFunctionName
  src: ./src
  runtime: Nodejs10.15 # 云函数的运行时环境。除 Nodejs10.15 外，可选值为：Python2.7、Python3.6、Nodejs6.10、Nodejs8.9、PHP5、PHP7、Go1、Java8。
  region: ap-guangzhou
  handler: index.main_handler
  events:
    - apigw:
        name: serverless_api
        parameters:
          protocols:
            - http
            - https
          serviceName:
          description: The service of Serverless Framework
          environment: release
          endpoints:
            - path: /index
              method: GET

点此查看全量配置及配置说明

当你根据该配置文件更新配置字段后，再次运行 serverless deploy 或者 serverless 就可以更新配置到云端。

部署了该云函数 SCF 应用后，可以通过开发调试能力对该项目进行二次开发，从而开发一个生产应用。在本地修改和更新代码后，不需要每次都运行 serverless deploy 命令来反复部署。你可以直接通过 serverless dev 命令对本地代码的改动进行检测和自动上传。

可以通过在 serverless.yml文件所在的目录下运行 serverless dev 命令开启开发调试能力。

serverless dev 同时支持实时输出云端日志，每次部署完毕后，对项目进行访问，即可在命令行中实时输出调用日志，便于查看业务情况和排障。

除了实时日志输出之外，针对 Node.js 应用，当前也支持云端调试能力。在开启 serverless dev 命令之后，将会自动监听远端端口，并将函数的超时时间临时配置为 900s。此时你可以通过访问 chrome://inspect/#devices 查找远端的调试路径，并直接对云端代码进行断点等调试。在调试模式结束后，需要再次部署从而将代码更新并将超时时间设置为原来的值。详情参考开发模式和云端调试。

在serverless.yml文件所在的目录下，通过如下命令查看部署状态：

$ serverless info

在serverless.yml文件所在的目录下，通过以下命令移除部署 SCF 应用。移除后该组件会对应删除云上部署时所创建的所有相关资源。

$ serverless remove

和部署类似，支持通过 sls remove --debug 命令查看移除过程中的实时日志信息，sls是 serverless 命令的缩写。

当前默认支持 CLI 扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 .env 文件

$ touch .env # 腾讯云的配置信息

在 .env 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存

如果没有腾讯云账号，可以在此注册新账号。

如果已有腾讯云账号，可以在API 密钥管理中获取 SecretId 和SecretKey.

# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123