ESA为您提供 CLI 工具,您可以通过 CLI 工具进行边缘函数全生命周期管理、调试、多文件功能部署等操作。
ESA CLI介绍
边缘安全加速 ESA CLI是ESA边缘函数配套命令行工具,通过ESA CLI您可以完成如下任务。
在本地完成边缘函数全生命周期管理,包括函数创建、版本发布与部署、触发器管理等。
在本地或内网环境完成函数调试。CLI支持启动本地调试服务,模拟线上环境进行功能测试。
支持多文件工程的部署。CLI将自动完成npm等项目依赖文件的打包构建,允许您将本地Node.js项目部署在云上。
常用命令
ESA CLI提供众多命令用来进行边缘函数管理。
命令 | 说明 |
命令 | 说明 |
init | 选择ESA提供的模板完成项目初始化。 |
dev | 自动启动本地调试服务。 |
commit | 提交项目代码至云上,并将其保存为一个版本。 |
deploy | 将某个版本部署在所有线上边缘节点。 |
deployments | 查看当前的版本部署情况,或删除某个版本。 |
routine | 查看所有边缘函数,或删除某个函数。 |
site | 查看账户下所有站点信息。 |
domain | 管理绑定到边缘函数的域名。 |
route | 管理绑定到边缘函数的路由。 |
login | 使用 AK/SK 完成账号登录。 |
logout | 注销登录。 |
config | 管理ESA CLI 的配置文件。 |
lang | 选择ESA CLI 的语言。 |
安装Node.js
您需要先安装Node.js,以使用ESA CLI。
安装命令:
yum install nodejs npm
。查看安装版本:
node -v
。
使用ESA CLI
使用npm完成ESA CLI 的安装,并查看 CLI 的版本和支持的命令。
npm install esa-cli -g # 全局安装CLI esa -v # 查看CLI版本 esa --help # 查看CLI命令
账号登录。首先访问阿里云RAM控制台获取您的
AccessKey ID
和AccessKey Secret
,再执行esa login
完成账号登录。如果您只是通过 CLI 在本地进行代码调试,则不需要进行账号登录。esa login # 登录 esa logout # 登出
项目初始化。包括填写项目名称、选择模板等,可根据初始化命令引导完成整个流程。
esa init
本地调试。完成代码后,可以通过 CLI 进行代码本地调试。执行
esa dev
指令后,会自动打包入口文件,并启动本地调试服务。在界面上按
b
即可在浏览器中打开调试页面。在界面上按
d
可以查看调试引导。注意:Chrome 不允许命令行打开调试页面。在 Chrome 浏览器中打开Chrome://inspect#devices
页面,可以看到一个运行的Remote Target
,点击下面的inspect
即可查看 console 信息。注意,EdgeRoutine 的代码为服务端代码,所以预览页面的控制台并不会输出入口文件中的console
,只能通过inspect
调试。在界面上按
c
可以清空面板。在界面上按
x
可以退出调试。可以用
esa dev --port <port>
临时指定端口。
版本生成。在本地调试完成后,需要生成一个代码版本用于部署。
esa commit # 生成版本
线上部署。当版本生成后,需要使用部署相关的指令,将版本部署至公有云边缘节点。
esa deploy # 根据提示选择版本、目标环境即可部署 esa deployments list # 查看部署情况 esa deployments delete <versionId> # 删除指定版本
管理触发器。
当被部署到节点后,您可以配置触发器,通过触发器可以访问您的边缘函数。触发器有两种:
域名:为您的函数绑定域名,该域名必须是您ESA站点的子域名,您可以通过域名直接访问到该函数,此时边缘函数将作为该域名的源站。
路由:为您的ESA站点绑定函数路由,访问该路由可触发边缘函数执行,此时边缘函数可以和站点的源站进行通信。
# 域名 esa domain list esa domain add <domainName> # 需要是您的已备案域名 esa domain delete <domainName> # 路由 esa route list esa route add [route] [site] esa route delete <route>
管理函数。
可以通过 CLI 查看、删除函数。
esa routine list # 查看函数 esa routine delete <routineName> # 删除函数
- 本页导读
- ESA CLI介绍
- 常用命令
- 安装Node.js
- 使用ESA CLI