您可以通过本教程了解faascmd命令的用法。

前提条件

使用faascmd工具之前,您需要先配置faascmd。具体操作,请参见配置faascmd

使用授权命令前,您需要完成以下操作:

  1. 已为FaaS新建一个OSS bucket,用于上传原始编译的DCP文件。
  2. 已在该FaaS OSS bucket中,新建一个名为compiling_logs的文件夹。

背景信息

faascmd语法说明如下:

  • faascmd工具提供的所有命令和参数都严格区分大小写。
  • faascmd命令中,参数、=、取值间不能有多余空格。

本文介绍的faascmd命令如下:

授权

faascmd auth命令用于授权faas admin访问您的OSS bucket。

命令格式:
faascmd auth --bucket=<YourFaasOSSBucketName>
示例代码:授权
说明 如果同一主账户下有多个RAM账户,建议RAM账户间共享一个OSS bucket,以避免重复修改或覆盖授权策略。

查看授权策略

faascmd list_policy命令用来查看指定的OSS bucket是否已添加到相应的授权策略(faasPolicy)里。

命令格式:
faascmd list_policy
示例代码:查看授权策略
说明 请关注您的OSS Bucket和OSS Bucket/compiling_logs是否出现在列出的策略信息中。

删除授权策略

faascmd delete_policy命令用于删除授权策略(faasPolicy)。

命令格式:
faascmd delete_policy
示例代码:删除授权策略
说明 如果同一主账户下有多个子账户,建议您通过RAM控制台操作,以避免误删授权策略。

查看OSS Bucket下所有的objects

faascmd list_objects命令用于查看OSS Bucket下所有的objects。

命令格式:
faascmd list_objects
示例代码:查看objects
说明 您可以配合grep命令筛选出您想要的文件。例如:faascmd list_objects | grep "xxx"

上传原始编译文件

faascmd upload_object命令用于将本地编译的原始文件上传到指定的OSS bucket中。

命令格式:
faascmd upload_object --object=<NewFileNameInOSSBucket> --file= <YourFilePath>/<FileNameYouWantToUpload>           
示例代码:upload_object
说明
  • 如果需上传的文件在当前目录下,则无需提供路径。
  • intel fpga的本地编译原始文件为.gbs格式;xilinx fpga的本地编译原始文件为脚本处理后得到的tar包。

下载OSS Bucket中的object

faascmd get_object命令用来下载OSS Bucket中指定的object。

命令格式:
faascmd get_object --object=<YourObjectName> --file=<YourLocalPath>/<YourFileName>
示例代码:get_object
说明 如果您不提供路径,则默认下载到当前文件夹。

新建fpga镜像

faascmd create_image命令用来提交制作fpga镜像的请求。请求成功时,返回fpga imageuuid。

命令格式:
faascmd create_image --object=<YourObjectName> 
--fpgatype=<intel/xilinx>  --encrypted=<true/false> 
--kmskey=<key/如果encrypted为true,必选;否则可选> 
--shell=<Shell Version/必选> --name=<name/可选> 
--description=<description/可选> --tags=<tags/可选>
示例代码:create_image

查看fpga镜像

faascmd list_images命令用于查看用户制作的所有fpga镜像的信息。

命令格式:
faascmd list_images
示例代码:list_images
说明 每个子账户最多允许保留10个fpga镜像。

删除fpga镜像

faascmd delete_image命令用于删除fpga镜像。

命令格式:
faascmd delete_image --imageuuid=<yourImageuuid>
示例代码:delete_image

下载fpga镜像

faascmd download_image命令用于提交下载fpga镜像的请求。

命令格式:
faascmd download_image  --instanceId=<YourInstanceId> 
--fpgauuid=<Yourfpgauuid> --fpgatype=<intel/xilinx> 
--imageuuid=<YourImageuuid> --imagetype=<afu> 
--shell=<YourImageShellVersion>
示例代码:
faascmd download_image --instanceId=XXXXX --fpgauuid=XXXX --fpgatype=intel --imageuuid=XXXX

查看fpga镜像下载状态

faascmd fpga_status命令用于查看当前fpga板卡状态或fpga镜像的下载进度。

命令格式:
faascmd fpga_status --fpgauuid=<Yourfpgauuid> --instanceId=<YourInstanceId>
示例代码:fpga_status

发布fpga镜像

faascmd publish_image命令用来提交发布fpga镜像的请求。

命令格式:
faascmd publish_image --imageuuid=<YourImageuuid> --imageid=<YourInstanceImageid>
说明
  • imageuuid是您要发布到云市场的fpga镜像id。您可以通过faascmd list_images命令查看。
  • imageid是fpga实例的镜像id。您可以通过ECS控制台的实例详情页查看。

查看fpga实例的信息

faascmd list_instances命令用于获取fpga实例的基本信息,包括实例id、fpga板卡信息和shell版本。

命令格式:
faascmd list_instances --instanceId=<YourInstanceId>
示例代码:list_instances