云函数 SCF 组件

最近更新时间:2020-11-30 10:36:09

组件概述

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

快速入门

前提条件

操作步骤

创建

  • 方式一:按照 快速部署 操作,选择 SCF 项目模板进行创建。
  • 方式二:直接使用 sls init 命令创建。快速创建一个 nodejs 的 SCF 示例:
    sls init scf-nodejs
    说明:

    目前 SCF 组件支持的 helloworld 模板有:scf-golang、scf-php、scf-python,只需要将命令中的 scf-nodejs 更换为前面列出的模版名称,即可快速初始化相应语言模版。

部署

执行以下命令,将会弹出二维码,直接扫码授权进行部署:

sls deploy
说明:

如果鉴权失败,请参考 权限配置 进行授权。

查看

执行以下命令,查看您部署的项目信息:

sls info

移除

执行以下命令,移除您已经部署的项目:

sls remove

进阶指导

serverless.yml

执行 sls deploy 时,根据 serverless.yml 文件中的配置对云函数资源进行创建或更新。一份简单的 serverlesss.yml 文件如下:

说明:

配置详情请参考 全量配置文档

#scf组件配置样例
#全量配置参考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: ./  #代码路径
handler: index.main_handler #入口
runtime: Nodejs10.15 # 云函数运行时的环境
region: ap-guangzhou # 云函数所在区域
events: # 触发器
  - apigw: # 网关触发器
      parameters:
        endpoints:
          - path: /
            method: GET

serverless.yml 文件包含的信息:

组件信息

组件名 是否必选 说明
component 必填 component 的名称,使用sls registry查询您可以引入的组件。
name 必填 创建的实例名称,每个组件在部署时将创建一个实例。

参数信息

inputs 下的参数为组件配置参数。一个最简单 SCF 组件参数配置由以下几部分:

参数名 说明
name 云函数名称。由于云函数又是资源 ID,为了保证资源的唯一性,建议采用 ${name}-${stage}-${app} 变量方式。
src 代码路径。
handler 函数处理方法名称 。
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 。

配置详情可参考 权限配置

开发调试

serverless.yml文件所在的目录下运行 sls dev 可以实时输出云端日志,每次部署完毕后,对项目进行访问,即可在命令行中实时输出调用日志,便于查看业务情况和排障。nodejs 支持开启开发调试能力,将会对本地代码的改动进行检测和自动上传。详情请参考 开发与调试

应用管理

Serverless 部署一个组件实例实质是部署了一个单组件实例的应用。

在应用项目开发过程中,一个应用下可能会存在多个组件实例,关于管理组件实例进行应用项目开发的说明,请参考 应用管理

组件命令

云函数组件提供了组件级的命令。对于sls deploy部署成功的云函数,可以通过以下命令操作云函数。

说明:

命令必须在 serverless.yml 同目录下执行。

函数发版本

将函数 my-function云端的 $LATEST 版本发布为一个固定版本:

sls publish-ver --inputs  function=my-function

创建别名

给云函数 my-function 创建别名 routing-alias,路由规则为版本1流量为50%,版本2流量为50%:

sls create-alias --inputs name=routing-alias  function=my-function  version=1  
config='{"weights":{"2":0.5}}'

更新别名

更新云函数 my-function 别名 routing-alias 的流量规则为版本1流量为10%,版本2流量为90%:

sls update-alias --inputs name=routing-alias  function=my-function  version=1 config='{"weights":{"2":0.9}}'

列举别名

列举云函数 my-function 别名 routing-alias:

sls list-alias --inputs function=my-function

删除别名

删除云函数 my-function 的别名 routing-alias:

sls delete-alias --inputs name=routing-alias  function=my-function

触发函数

云端调用 functionName 函数,并传递 json 参数{"weights":{"2":0.1}}

sls invoke  --inputs function=functionName  clientContext='{"weights":{"2":0.1}}'
目录