tencent cloud

文档反馈

快速部署 Egg 框架

最后更新时间:2022-07-22 15:11:39

    应用中心框架部署方案已经全新升级,您可以通过 SCF Web Function,快速部署您的 Egg 业务上云。

    注意:

    应用控制台部署与函数直接部署有什么区别?
    通过应用部署或函数部署,均可以基于 Web 函数,快速部署常见 Web 框架。

    • 如果您只关注代码逻辑开发,无需额外资源创建,可以通过 Serverless控制台,完成快速部署。
    • 如果除了代码部署外,您还需要更多能力或资源创建,如自动创建层托管依赖、一键实现静态资源分离、支持代码仓库直接拉取等,可以通过应用控制台,完成 Web 应用的创建工作。

    本篇文档为您介绍应用控制台的部署方案,您也可以通过命令行完成部署,具体操作请参考 产品文档

    模板部署 -- 部署 Egg 示例代码

    1. 登录 Serverless 控制台
    2. 单击新建应用,选择Web 应用>Egg 框架
    3. 单击“下一步”,完成基础配置选择。
    4. 上传方式,选择示例代码直接部署,单击完成,即可开始应用的部署。
    5. 部署完成后,您可在应用详情页面,查看示例应用的基本信息,并通过 API 网关生成的访问路径 URL 进行访问,查看您部署的 Egg 项目。

    自定义部署 -- 快速部署 Web 应用

    前提条件

    本地已安装 Node.js 运行环境。

    本地开发

    1. 参考 Egg.js 官方文档,快速初始化示例项目:
      mkdir egg-example && cd egg-example
      npm init egg --type=simple
      npm i
      
    1. 在根目录下,执行以下命令在本地直接启动服务。
      npm run dev
      open http://localhost:7001
      
    1. 打开浏览器,即可在本地完成 Egg 示例项目的访问。

    部署上云

    接下来执行以下步骤,对本地已创建完成的项目进行简单修改,使其可以通过 Web Function 快速部署,对于 Egg 框架,具体改造说明如下:

    • 修改监听地址与端口为 0.0.0.0:9000
    • 修改写入路径,serverless 环境下只有 /tmp 目录可读写。
    • 新增 scf_bootstrap 启动文件。

    1. (可选)配置 scf_bootstrap 启动文件

    说明:

    您也可以在控制台完成该模块配置。

    在项目根目录下新建 scf_bootstrap 启动文件,在该文件添加如下内容(用于配置环境变量和启动服务,此处仅为示例,具体操作请以您实际业务场景来调整):

    #!/var/lang/node12/bin/node
    'use strict';
    /**
    * docker 中 node 路径:/var/lang/node12/bin/node
    * 由于 serverless 函数只有 /tmp 读写权限,所以在启动时需要修改两个环境变量
    * NODE_LOG_DIR 是为了改写 egg-scripts 默认 node 写入路径(~/logs)-> /tmp
    * EGG_APP_CONFIG 是为了修改 egg 应有的默认当前目录 -> /tmp
    */
    process.env.EGG_SERVER_ENV = 'prod';
    process.env.NODE_ENV = 'production';
    process.env.NODE_LOG_DIR = '/tmp';
    process.env.EGG_APP_CONFIG = '{"rundir":"/tmp","logger":{"dir":"/tmp"}}';
    const { Application } = require('egg');
    // 如果通过层部署 node_modules 就需要修改 eggPath
    Object.defineProperty(Application.prototype, Symbol.for('egg#eggPath'), {
    value: '/opt',
    });
    const app = new Application({
    mode: 'single',
    env: 'prod',
    });
    app.listen(9000, '0.0.0.0', () => {
    console.log('Server start on http://0.0.0.0:9000');
    });
    

    新建完成后,还需执行以下命令修改文件可执行权限,默认需要 777755 权限才可正常启动。示例如下:

    chmod 777 scf_bootstrap
    

    2. 控制台上传

    登录 Serverless 控制台,选择Web 应用>Egg 框架,上传方式可以选择本地上传代码仓库拉取

    您可以在控制台完成启动文件 scf_bootstrap 内容配置,配置完成后,控制台将为您自动生成 启动文件,和项目代码一起打包部署。

    注意:

    启动文件以项目内文件为准,如果您的项目里已经包含 scf_bootstrap 文件,将不会覆盖该内容。

    配置完成后,单击完成,部署您的 Egg 项目。

    高级配置管理

    您可在“高级配置”里进行更多应用管理操作,如创建层、绑定自定义域名、配置环境变量等。

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持