@serverless/tencent-egg

    1.0.7 • Public • Published

    Serverless Egg Tencent Cloud

    腾讯云 Egg.js Serverless Component

    npm NPM downloads

    简体中文 | English

    简介

    腾讯云 Egg.js Serverless Component。

    目录

    1. 准备
    2. 安装
    3. 配置
    4. 部署
    5. 移除

    0. 准备

    初始化 Egg 项目

    $ mkdir egg-example && cd egg-example
    $ npm init egg --type=simple
    $ npm i

    修改 Egg 配置

    由于云函数在执行时,只有 /tmp 可读写的,所以我们需要将 egg.js 框架运行尝试的日志写到该目录下,为此需要修改 config/config.default.js 中的配置如下:

    const config = (exports = {
      env: 'prod', // 推荐云函数的 egg 运行环境变量修改为 prod
      rundir: '/tmp',
      logger: {
        dir: '/tmp'
      }
    })

    1. 安装

    通过 npm 全局安装 serverless cli

    $ npm install -g serverless

    2. 配置

    在项目根目录创建 serverless.yml 文件,在其中进行如下配置

    $ touch serverless.yml
    # serverless.yml
     
    MyComponent:
      component: '@serverless/tencent-egg'
      inputs:
        region: ap-guangzhou
        functionName: egg-function
        runtime: Nodejs8.9
        code: ./
        functionConf:
          timeout: 10
          memorySize: 128
          environment:
            variables:
              TEST: vale
          vpcConfig:
            subnetId: ''
            vpcId: ''
        apigatewayConf:
          protocols:
            - https
          environment: release

    3. 部署

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

    通过 sls 命令进行部署,并可以添加 --debug 参数查看部署过程中的信息

    $ sls --debug
     
      DEBUG ─ Resolving the template's static variables.
      DEBUG ─ Collecting components from the template.
      DEBUG ─ Downloading any NPM components found in the template.
      DEBUG ─ Analyzing the template's components dependencies.
      DEBUG ─ Creating the template's components graph.
      DEBUG ─ Syncing template state.
      DEBUG ─ Executing the template's components graph.
      DEBUG ─ Compressing function egg-function file to /Users/yugasun/Desktop/Develop/serverless/tencent-egg/example/.serverless/egg-function.zip.
      DEBUG ─ Compressed function egg-function file successful
      DEBUG ─ Uploading service package to cos[sls-cloudfunction-ap-guangzhou-code]. sls-cloudfunction-default-egg-function-1584348537.zip
      DEBUG ─ Uploaded package successful /Users/yugasun/Desktop/Develop/serverless/tencent-egg/example/.serverless/egg-function.zip
      DEBUG ─ Creating function egg-function
      egg-function [████████████████████████████████████████] 100% | ETA: 0s | Speed: 4422.09k/s
      DEBUG ─ Updating code...
      DEBUG ─ Updating configure...
      DEBUG ─ Created function egg-function successful
      DEBUG ─ Setting tags for function egg-function
      DEBUG ─ Creating trigger for function egg-function
      DEBUG ─ Deployed function egg-function successful
      DEBUG ─ Starting API-Gateway deployment with name ap-guangzhou-apigateway in the ap-guangzhou region
      DEBUG ─ Using last time deploy service id service-jkcevoqw
      DEBUG ─ Updating service with serviceId service-jkcevoqw.
      DEBUG ─ Endpoint ANY / already exists with id api-et0yjwci.
      DEBUG ─ Updating api with api id api-et0yjwci.
      DEBUG ─ Service with id api-et0yjwci updated.
      DEBUG ─ Deploying service with id service-jkcevoqw.
      DEBUG ─ Deployment successful for the api named ap-guangzhou-apigateway in the ap-guangzhou region.
     
      MyEgg:
        functionName:        egg-function
        functionOutputs:
          ap-guangzhou:
            Name:        egg-function
            Runtime:     Nodejs8.9
            Handler:     serverless-handler.handler
            MemorySize:  128
            Timeout:     10
            Region:      ap-guangzhou
            Namespace:   default
            Description: This is a template function
        region:              ap-guangzhou
        apiGatewayServiceId: service-jkcevoqw
        url:                 https://service-jkcevoqw-1251556596.gz.apigw.tencentcs.com/release/
        cns:                 (empty array)

    注意: slsserverless 命令的简写。

    4. 移除

    通过以下命令移除部署的 Egg 服务资源,包括云函数和 API 网关。

    $ sls remove --debug
     
      DEBUG ─ Flushing template state and removing all components.
      DEBUG ─ Removed function egg-function successful
      DEBUG ─ Removing any previously deployed API. api-et0yjwci
      DEBUG ─ Removing any previously deployed service. service-jkcevoqw
     
      10s › MyEgg › done

    账号配置(可选)

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

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

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

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

    如果已有腾讯云账号,可以在 API 密钥管理 中获取 SecretIdSecretKey.

    # .env
    TENCENT_SECRET_ID=123
    TENCENT_SECRET_KEY=123

    注意!!!

    通常初始化的 egg 项目,会自动创建 app/public 目录。但是在打包压缩时,如果该目录为空,则部署后,该目录不会存在。所以 egg 项目启动时会自动创建,但是云函数是没有操作权限的,建议可以在 app/public 目录下创建一个空文件 .gitkeep,来解决此问题。

    更多组件

    可以在 Serverless Components repo 中查询更多组件的信息。

    常见问题解答

    1. 部署时一直处于打包压缩阶段

    Install

    npm i @serverless/tencent-egg

    DownloadsWeekly Downloads

    27

    Version

    1.0.7

    License

    Apache-2.0

    Unpacked Size

    35.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar