本文主要介紹faascmd命令的用法和樣本。
前提條件
faascmd命令概覽
命令文法說明
faascmd工具提供的所有命令和參數都嚴格區分大小寫。
faascmd命令中,
參數
、=
以及取值間
不能存在多餘空格。
faascmd命令用途
faascmd支援的命令主要用於管理授權、配置環境以及管理FPGA鏡像等,相關內容如下所示:
用途 | 相關文檔 |
管理授權 | |
配置環境 | |
管理FPGA鏡像 |
授權訪問
faascmd auth
命令用於授權faas administrator訪問您的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
是否出現在列出的策略資訊中。
刪除授權策略
如果您不再需要授權策略(faasPolicy),可通過faascmd delete_policy
命令刪除該授權策略。
命令格式:
faascmd delete_policy
範例程式碼:
如果同一主帳號下有多個RAM使用者,建議您通過RAM控制台刪除策略,可以有效避免授權策略的誤刪操作。
查看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>
範例程式碼:
如果需上傳的檔案在目前的目錄下,則無需提供路徑。
Intel FPGA的本地編譯原始檔案為.gbs格式;Xilinx FPGA的本地編譯原始檔案為指令碼處理後得到的tar包。
下載OSS bucket中的object
faascmd get_object
命令用來下載OSS bucket中指定的object。
命令格式:
faascmd get_object --object=<YourObjectName> --file=<YourLocalPath>/<YourFileName>
範例程式碼:
如果您不提供路徑,則預設下載到當前檔案夾路徑。
建立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鏡像下載狀態
faascmd fpga_status
命令用於查看當前FPGA板卡狀態或FPGA鏡像的下載進度。
命令格式:
faascmd fpga_status --fpgauuid=<Yourfpgauuid> --instanceId=<YourInstanceId>
範例程式碼:
發布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>
範例程式碼: