使用faascmd
本文主要介紹faascmd命令的用法和示例。
前提條件
已配置faascmd工具。具體操作，請參見配置faascmd。
已為FaaS新建一個OSS bucket，用于上傳原始編譯的DCP文件。具體操作，請參見控制臺創(chuàng)建存儲空間。
已在新創(chuàng)建的FaaS OSS bucket中，新建一個名為compiling_logs的文件夾。具體操作，請參見創(chuàng)建目錄。
faascmd命令概覽
命令語法說明
faascmd工具提供的所有命令和參數(shù)都嚴(yán)格區(qū)分大小寫。
faascmd命令中，
參數(shù)、=以及取值間不能存在多余空格。
faascmd命令用途
faascmd支持的命令主要用于管理授權(quán)、配置環(huán)境以及管理FPGA鏡像等，相關(guān)內(nèi)容如下所示：
用途 | 相關(guān)文檔 |
管理授權(quán) | |
配置環(huán)境 | |
管理FPGA鏡像 |
授權(quán)訪問
faascmd auth命令用于授權(quán)faas administrator訪問您的OSS bucket。
命令格式：
faascmd auth --bucket=<YourFaasOSSBucketName>示例代碼：
如果同一主賬號下有多個RAM用戶，則建議RAM用戶之間共享一個OSS bucket，可以有效避免重復(fù)修改或覆蓋授權(quán)策略。
查看授權(quán)策略
faascmd list_policy命令用來查看指定的OSS bucket是否已添加到相應(yīng)的授權(quán)策略（faasPolicy）里。
命令格式：
faascmd list_policy示例代碼：
請關(guān)注您的OSS bucket和OSS bucket/compiling_logs是否出現(xiàn)在列出的策略信息中。
刪除授權(quán)策略
如果您不再需要授權(quán)策略（faasPolicy），可通過faascmd delete_policy命令刪除該授權(quán)策略。
命令格式：
faascmd delete_policy示例代碼：
如果同一主賬號下有多個RAM用戶，建議您通過RAM控制臺刪除策略，可以有效避免授權(quán)策略的誤刪操作。
查看OSS bucket下所有的objects
faascmd list_objects命令用于查看OSS bucket下所有的objects。
命令格式：
faascmd list_objects示例代碼：
您可以配合grep命令篩選出您想要的文件。例如：faascmd list_objects | grep "xxx" 。
上傳原始編譯文件
faascmd upload_object命令用于將本地編譯的原始文件上傳到指定的OSS bucket中。
命令格式：
faascmd upload_object --object=<NewFileNameInOSSBucket> --file=<YourFilePath>/<FileNameYouWantToUpload> 示例代碼：
如果需上傳的文件在當(dāng)前目錄下，則無需提供路徑。
Intel FPGA的本地編譯原始文件為.gbs格式；Xilinx FPGA的本地編譯原始文件為腳本處理后得到的tar包。
下載OSS bucket中的object
faascmd get_object命令用來下載OSS bucket中指定的object。
命令格式：
faascmd get_object --object=<YourObjectName> --file=<YourLocalPath>/<YourFileName>示例代碼：
如果您不提供路徑，則默認(rèn)下載到當(dāng)前文件夾路徑。
新建FPGA鏡像
faascmd create_image命令用來提交制作FPGA鏡像的請求。請求成功時，返回FpgaImageUUID。
命令格式：
faascmd create_image --object=<YourObjectName>
--fpgatype=<intel/xilinx> --encrypted=<true/false>
--kmskey=<key/如果encrypted為true，必選；否則可選>
--shell=<Shell Version/必選> --name=<name/可選>
--description=<description/可選> --tags=<tags/可選>示例代碼：
查看FPGA鏡像
faascmd list_images命令用于查看用戶制作的所有FPGA鏡像的信息。
命令格式：
faascmd list_images示例代碼：
每個RAM用戶最多允許保留10個FPGA鏡像。
刪除FPGA鏡像
如果您不再需要FPGA鏡像，可通過faascmd delete_image命令刪除該鏡像。
命令格式：
faascmd delete_image --imageuuid=<yourImageuuid>示例代碼：
下載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鏡像下載狀態(tài)
faascmd fpga_status命令用于查看當(dāng)前FPGA板卡狀態(tài)或FPGA鏡像的下載進(jìn)度。
命令格式：
faascmd fpga_status --fpgauuid=<Yourfpgauuid> --instanceId=<YourInstanceId>示例代碼：
發(fā)布FPGA鏡像
faascmd publish_image命令用來提交發(fā)布FPGA鏡像的請求。
命令格式：
faascmd publish_image --imageuuid=<YourImageuuid> --imageid=<YourInstanceImageid>imageuuid是您要發(fā)布到云市場的FPGA鏡像id。您可以通過
faascmd list_images命令查看。imageid是FPGA實(shí)例的鏡像id。您可以通過ECS管理控制臺的實(shí)例詳情頁查看。
查看FPGA實(shí)例的信息
faascmd list_instances命令用于獲取FPGA實(shí)例的基本信息，包括實(shí)例ID、FPGA板卡信息和Shell版本。
命令格式：
faascmd list_instances --instanceId=<YourInstanceId>示例代碼：