Serverless Python Flask Tencent Cloud

#简介

腾讯云 Flask Serverless Component, 支持 Restful API 服务的部署,不支持 Flask Command.

注 :任何支持 WSGI (Web Server Gateway Interface) 的 Python 服务端框架都可以通过该组件进行部署,例如 Falcon 框架等。

#目录

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

#0. 准备 `

在使用此组件之前,需要先初始化一个 Flask 项目,然后将 Flaskwerkzeug 添加到依赖文件 requiements.txt 中,如下:

Flask==1.0.2
werkzeug==0.16.0

同时新增 API 服务 app.py,下面代码仅供参考:

from flask import Flask, jsonify
app = Flask(__name__)

@app.route("/")
def index():
    return "Hello Flash"

@app.route("/users")
def users():
    users = [{'name': 'test1'}, {'name': 'test2'}]
    return jsonify(data=users)

@app.route("/users/<id>")
def user(id):
    return jsonify(data={'name': 'test1'})

#1. 安装

通过 npm 全局安装 serverless cli

$ npm install -g serverless

#2. 配置

本地创建 serverless.yml 文件,在其中进行如下配置

$ touch serverless.yml
# serverless.yml

MyComponent:
  component: '@serverless/tencent-flask'
  inputs:
    region: ap-guangzhou
    functionName: flask-function
    code: ./
    functionConf:
      timeout: 10
      memorySize: 128
      environment:
        variables:
          TEST: vale
      vpcConfig:
        subnetId: ''
        vpcId: ''
    apigatewayConf:
      protocol: https
      environment: release

#3. 部署

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

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

注意: slsserverless 命令的简写。

$ 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 ─ Generated requirements from /Users/Downloads/myapp/requirements.txt in /Users/Downloads/myapp/.serverless/requirements.txt...
  DEBUG ─ Installing requirements from /Users/Library/Caches/serverless-python-requirements/78f1b71bd84112bad004679c938bd8c63c80ddf8c468c5484e3de8214a52a8bc_slspyc/requirements.txt ...
  DEBUG ─ Using download cache directory /Users/Library/Caches/serverless-python-requirements/downloadCacheslspyc
  DEBUG ─ Running ...
  DEBUG ─ Compressing function flask-function file to /Users/Downloads/myapp/.serverless/flask-function.zip.
  DEBUG ─ Compressed function flask-function file successful
  DEBUG ─ Uploading service package to cos[sls-cloudfunction-ap-guangzhou-code]. sls-cloudfunction-default-flask-function-1581890739.zip
  DEBUG ─ Uploaded package successful /Users/Downloads/myapp/.serverless/flask-function.zip
  DEBUG ─ Creating function flask-function
  DEBUG ─ Created function flask-function successful
  DEBUG ─ Setting tags for function flask-function
  DEBUG ─ Creating trigger for function flask-function
  DEBUG ─ Deployed function flask-function successful
  DEBUG ─ Starting API-Gateway deployment with name MyComponent.TencentApiGateway in the ap-guangzhou region
  DEBUG ─ Service with ID service-rf5pzbfy created.
  DEBUG ─ API with id api-6i3uv432 created.
  DEBUG ─ Deploying service with id service-rf5pzbfy.
  DEBUG ─ Deployment successful for the api named MyComponent.TencentApiGateway in the ap-guangzhou region.

  MyComponent:
    region:              ap-guangzhou
    functionName:        flask-function
    apiGatewayServiceId: service-rf5pzbfy
    url:                 http://service-rf5pzbfy-1258834142.gz.apigw.tencentcs.com/release/

  75s › MyComponent › done

#4. 移除

通过以下命令移除部署的 API 网关和云函数

$ sls remove --debug

  DEBUG ─ Flushing template state and removing all components.
  DEBUG ─ Removing function
  DEBUG ─ Request id
  DEBUG ─ Removed function flask-function successful
  DEBUG ─ Removing any previously deployed API. api-6i3uv432
  DEBUG ─ Removing any previously deployed service. service-rf5pzbfy

  17s › MyComponent › done

#账号配置(可选)

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

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

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

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

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

# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123