后端ServerlessCLI【免費下載鏈接】chalicePython Serverless Microframework for AWS項目地址https://gitcode.com/gh_mirrors/ch/chalice點擊查看免費下載導(dǎo)讀本指南以 AWS 開源 Python Serverless 微框架 Chalice 的.chalice/config.json配置文件為絕對主線系統(tǒng)講解如何通過該文件控制chalice deploy的全部行為從 stage 級與全局級配置的優(yōu)先級規(guī)則、API Gateway 端點與自定義域名配置到 IAM 角色與策略管理、VPC 網(wǎng)絡(luò)、環(huán)境變量、Lambda 函數(shù)級差異化配置等。讀完本文你將能夠不修改一行應(yīng)用代碼僅靠配置文件就完成多環(huán)境dev/beta/prod的差異化部署、為不同 Lambda 函數(shù)分配不同資源與權(quán)限、并把 API 掛載到自定義域名。配置文件是什么每次使用chalice new-project創(chuàng)建新項目時Chalice 都會為你生成一個.chalice目錄其中包含一個config.json文件用來控制chalice deploy時的部署行為。項目目錄結(jié)構(gòu)如下$ tree -a . ├── .chalice │ └── config.json ├── app.py └── requirements.txt 1 directory, 3 files從源碼看config.json的內(nèi)容通過 chalice/config.py 中的Config類被加載與解析。該類將配置值來源劃分為三層優(yōu)先級Config.__init__與_chain_lookup方法體現(xiàn)用戶顯式傳入的參數(shù)user_provided_params通常來自命令行例如--profile prod磁盤上的配置文件config_from_disk即.chalice/config.json的json.loads()結(jié)果默認(rèn)值default_params。_chain_lookup依次在這幾個字典中查找鍵取第一個非None的值。在 chalice/cli/factory.py 的create_config_obj中可以看到內(nèi)置的默認(rèn)參數(shù)api_gateway_stage使用默認(rèn) API Gateway 階段名、api_gateway_endpoint_type使用DEFAULT_ENDPOINT_TYPE、autogen_policy默認(rèn)為True。階段Stage專屬配置從 Chalice 0.7.0 開始你可以同時指定某個 chalice stage 專屬的配置以及跨所有 stage 共享的全局配置。有關(guān) chalice stage 概念的完整說明見 stages 文檔。stages該鍵的值是一個從 chalice stage 名稱到 stage 配置的映射。Chalice 默認(rèn)的 stage 名為dev。如果你使用 0.7.0 及以上版本的chalice new-project該鍵及默認(rèn)的dev鍵會自動創(chuàng)建。以下配置項既可以放在某個 stage 的配置中也可以作為不綁定具體 stage 的頂層鍵。當(dāng)需要某個 stage 專屬的配置值時Chalice優(yōu)先檢查stages映射若未找到再檢查頂層鍵。這一查找順序正是 config.py 中_chain_lookup的參數(shù)varies_per_chalice_stageTrue所實現(xiàn)的邏輯——凡是標(biāo)注“隨 stage 變化”的配置都會先把config_from_disk[stages][當(dāng)前stage]插入查找鏈中。api_gateway_endpoint_type所部署 API Gateway 的端點配置決定了 API 的訪問方式可選值為EDGE、REGIONAL、PRIVATE。注意該值只能作為頂層鍵設(shè)置默認(rèn)值為EDGE。在 chalice/deploy/validate.py 的validate_endpoint_type中會對該值進行校驗合法取值僅限上述三種否則部署時直接拋出ValueError。api_gateway_endpoint_vpce當(dāng)配置 Private APIapi_gateway_endpoint_type為PRIVATE時必須指定一個 VPC Endpoint id用于在沒有顯式策略時為 API 配置默認(rèn)資源策略。該值可以是單個字符串也可以是端點 id 的列表。在 appgraph.py 中可以看到若該值是字符串會被包裝成單元素列表并最終傳給RestAPI.vpce_ids。api_gateway_policy_file指向 REST API 的 IAM 資源策略文件。若未指定且端點類型為PRIVATEChalice 會自動生成該策略。該文件名相對于.chalice目錄。在 appgraph.py 中該文件會被封裝為FileBasedIAMPolicy其完整路徑為os.path.join(config.project_dir, .chalice, policy_path)。注意 validate.py 的validate_resource_policy中有一組嚴(yán)格的互斥校驗api_gateway_endpoint_vpce只能在端點類型為PRIVATE時指定否則報錯api_gateway_policy_file與api_gateway_endpoint_vpce二者只能指定其一若端點類型為PRIVATE則必須提供api_gateway_policy_file或api_gateway_endpoint_vpce中的至少一個。api_gateway_stageAPI Gateway 階段stage的名稱。它同時也是 API 的 URL 前綴https://endpoint/prefix/your-api。autogen_policy布爾值表示 Chalice 是否基于應(yīng)用源碼分析自動生成 IAM 策略。默認(rèn)值為true。若為falseChalice 會改為從磁盤加載.chalice/policy-stage-name.json作為 IAM 策略而不是通過源碼分析自動生成。你可以通過iam_policy_file配置項更改該文件名。IAM 角色與策略的更多配置示例見下文“IAM Roles and Policies”。environment_variables鍵值對映射這些鍵值對會作為環(huán)境變量注入應(yīng)用。所有環(huán)境變量的值必須是字符串——這一點在 validate.py 的validate_environment_variables_type中有強制校驗非字符串值會直接拋錯。如果該鍵同時出現(xiàn)在 stage 配置和頂層鍵中stage 專屬的環(huán)境變量會合并進頂層鍵stage 覆蓋同名頂層鍵。這一行為在源碼中由_chain_merge方法config.py實現(xiàn)它按“默認(rèn)值 → 頂層 → stage → 函數(shù)級 → 用戶參數(shù)”的順序逐一dict.update合并后出現(xiàn)的字典覆蓋先出現(xiàn)的鍵。具體示例見下文“環(huán)境變量”部分。iam_policy_file當(dāng)autogen_policy為false時Chalice 從磁盤加載 IAM 策略而不是基于源碼分析自動生成。默認(rèn)位置是.chalice/policy-stage-name.json例如.chalice/policy-dev.json、.chalice/policy-prod.json等?？梢酝ㄟ^iam_policy_file更改文件名路徑相對于.chalice目錄。例如{ version: 2.0, app_name: app, stages: { dev: { autogen_policy: false, iam_policy_file: my-policy.json } } }上述配置會讓 Chalice 使用.chalice/my-policy.json創(chuàng)建 IAM 角色。iam_role_arn當(dāng)manage_iam_role為false時必須指定該值用于指明應(yīng)用配置時使用的 IAM 角色 ARN。該值僅在manage_iam_role為false時生效。源碼 validate.py 的_validate_manage_iam_role強制了這一約束如果manage_iam_role為假且未提供iam_role_arnchalice deploy會直接報錯。lambda_memory_size整數(shù)表示 Lambda 函數(shù)分配的內(nèi)存大小MB。AWS Lambda 會根據(jù)內(nèi)存大小推斷分配給函數(shù)的 CPU 資源。默認(rèn)值為128且必須是 64 MB 的倍數(shù)。在 chalice/constants.py 中DEFAULT_LAMBDA_MEMORY_SIZE 128正是該默認(rèn)值的來源。lambda_timeout整數(shù)表示 AWS Lambda 終止函數(shù)執(zhí)行的超時時間秒。默認(rèn)lambda_timeout為60秒。layersLambda Layers ARN 的列表。該值既可以按 stage 提供也可以按單個 Lambda 函數(shù)提供。automatic_layer布爾值表示 Chalice 是否自動為所有 Lambda 函數(shù)構(gòu)建一個包含requirements.txt依賴庫與 vendored 庫的 stage 級 Layer。若不指定默認(rèn)值為false。在 config.py 中該屬性的默認(rèn)處理是未配置None時返回False。依賴打包的更多細節(jié)見 packaging 文檔。api_gateway_custom_domain鍵值對映射用于 REST API 的自定義域名。指定時必須包含以下必需鍵domain_name要關(guān)聯(lián)到 REST API 的自定義域名如api.example.comcertificate_arn當(dāng)前域名的 ACM 證書 ARN。若 API 使用REGIONAL端點類型ACM 證書必須與 API 在同一區(qū)域若使用EDGE端點類型證書必須在us-east-1?？蛇x配置tls_version該域名安全策略的 TLS 版本。默認(rèn)TLS_1_2REST API 也可使用TLS_1_0url_prefix自定義域名加url_prefixBasePathMapping標(biāo)識了給定 stage 中部署的 REST API。設(shè)置自定義域名后你可以設(shè)定 API 的主機名并選擇一個基礎(chǔ)路徑如myservice將替代 URL 映射到你的 API例如https://api.example.com/myservice。若不設(shè)置url_prefixAPI 的基礎(chǔ) URL 與自定義域名相同例如https://api.example.com/tags標(biāo)簽字典鍵為標(biāo)簽鍵值為標(biāo)簽值。自定義域名的完整配置指南見 domainname 文檔。websocket_api_custom_domain與api_gateway_custom_domain完全對應(yīng)的 WebSocket API 版本鍵值對映射指定時同樣必須包含domain_name與certificate_arn可選配置與 REST API 版本一致tls_version、url_prefix、tags。從源碼 config.py 可以看到兩者分別對應(yīng)獨立的配置屬性。manage_iam_roletrue/false。表示是否由 Chalice 創(chuàng)建并更新應(yīng)用使用的 IAM 角色。默認(rèn)值為true。如果你已有預(yù)先創(chuàng)建的角色可將其設(shè)為false此時 Chalice 不會創(chuàng)建或更新角色manage_iam_role: false意味著你需要自行管理該角色及其關(guān)聯(lián)策略。若設(shè)為false必須指定iam_role_arn否則運行chalice deploy時會報錯。minimum_compression_size整數(shù)表示應(yīng)用到 API Gateway 的最小壓縮大小。若該鍵同時出現(xiàn)在 stage 配置與頂層鍵中stage 專屬值會覆蓋頂層值。其取值范圍在 validate.py 中校驗必須位于MIN_COMPRESSION_SIZE0與MAX_COMPRESSION_SIZE10485760之間見 constants.py且必須是整數(shù)。reserved_concurrency整數(shù)表示每個函數(shù)的預(yù)留并發(fā)reserved concurrency。該值可以按 stage 提供也可以按單個 Lambda 函數(shù)提供。AWS Lambda 會為該 stage 中部署的每個 Lambda 預(yù)留該并發(fā)數(shù)。若設(shè)為0該函數(shù)的調(diào)用將被阻塞若未設(shè)置則不進行預(yù)留并發(fā)分配。subnet_idsVPC 配置的子網(wǎng) id 列表。該值可以按 stage 提供也可以按單個 Lambda 函數(shù)提供。要使其生效必須同時提供security_group_ids。當(dāng)兩者都提供且autogen_policy為True時Chalice 會自動更新 IAM 角色加入創(chuàng)建、描述、刪除 ENI彈性網(wǎng)絡(luò)接口所需的權(quán)限。如果你自行管理 IAM 角色策略請務(wù)必相應(yīng)更新權(quán)限。security_group_idsVPC 配置的安全組列表。該值可以按 stage 提供也可以按單個 Lambda 函數(shù)提供。要使其生效必須同時提供subnet_ids。tags鍵值對映射這些鍵值對會作為部署應(yīng)用的運行資源的標(biāo)簽。所有標(biāo)簽鍵和值必須是字符串。與environment_variables類似如果某鍵同時出現(xiàn)在 stage 配置與頂層鍵中stage 專屬標(biāo)簽會合并進頂層鍵。默認(rèn)情況下Chalice 部署的所有資源都會被標(biāo)記上aws-chalice鍵值為version{chalice-version}:stage{stage-name}:app{app-name}。目前只有 Lambda 函數(shù)會被打標(biāo)簽——這一默認(rèn)標(biāo)簽的拼接邏輯可以直接在 config.py 的tags屬性中看到。xray布爾值開啟 AWS X-Ray 的 Active tracing 配置。開啟后 X-Ray 將同時作用于 Lambda 函數(shù)和 API Gateway 階段。log_retention_in_days整數(shù)表示應(yīng)用到 Lambda 函數(shù)日志組的保留時間天。只有特定的值有效請參考 AWS CloudWatch Logs 的PutRetentionPolicy接口文檔。警告如果你使用chalice package命令生成 CloudFormation 模板模板中會新增一個帶配置的log_retention_in_days的 Log Group 資源。如果該 Log Group 資源已經(jīng)存在例如相關(guān) Lambda 函數(shù)此前已被調(diào)用Lambda 自動為函數(shù)創(chuàng)建了 Log Group部署會失敗。因此該配置應(yīng)放在 Lambda 函數(shù)的首次部署中。Lambda 函數(shù)級Per-Function配置除 chalice stage 之外還有一些配置值可以按單個 Lambda 函數(shù)指定。一個 chalice app 可以有多個 stage而一個 stage 可以包含多個 Lambda 函數(shù)。你可以選擇為某個函數(shù)在所有 stage 中統(tǒng)一配置也可以為某個函數(shù)在特定 stage 中單獨配置。要為特定 stage 下的某函數(shù)配置在 stage 配置中添加lambda_functions鍵{ version: 2.0, app_name: app, stages: { dev: { lambda_functions: { foo: { lambda_timeout: 120 } } } } }要為某函數(shù)跨所有 stage 配置添加頂層lambda_functions鍵{ version: 2.0, app_name: app, lambda_functions: { foo: { lambda_timeout: 120 } } }lambda_functions字典中的每個鍵是應(yīng)用中某個 Lambda 函數(shù)的名稱值是該函數(shù)要應(yīng)用的配置字典?？梢园春瘮?shù)應(yīng)用的配置選項包括autogen_policyenvironment_variablesiam_policy_fileiam_role_arnlambda_memory_sizelambda_timeoutlayersmanage_iam_rolereserved_concurrencysecurity_group_idssubnet_idstagslog_retention_in_days這些選項的詳細說明見上文“階段專屬配置”一節(jié)。函數(shù)級配置的查找順序在 config.py 的_chain_lookup中有清晰的注釋注釋config[stages][stage][lambda_functions][function] config[stages][stage] config[lambda_functions][function] config頂層 默認(rèn)值一般地Lambda 函數(shù)的名稱對應(yīng)應(yīng)用中的函數(shù)名。例如app.lambda_function() def foo(event, context): pass要為該函數(shù)指定配置就在lambda_functions配置中使用鍵foo。唯一的例外是使用app.route()裝飾器裝飾的 Python 函數(shù)。Chalice 為 API Gateway 的所有請求使用單個Lambda 函數(shù)其名稱為api_handler該名稱即 constants.py 中的DEFAULT_HANDLER_NAME。例如有以下應(yīng)用app.route(/) def index(): pass app.route(/foo/bar) def other_handler(): pass要為index()和other_handler()共享的底層 Lambda 函數(shù)指定配置值應(yīng)這樣寫{ lambda_functions: { api_handler: { subnet_ids: [sn-1, sn-2], security_group_ids: [sg-10, sg-11], layers: [layer-arn-1, layer-arn-2] } } }配置示例以下示例展示了如何配置你的 chalice 應(yīng)用。自定義域名為 REST API 的devstage 配置自定義域名的示例{ version: 2.0, app_name: app, stages: { dev: { autogen_policy: true, api_gateway_stage: dev, api_gateway_custom_domain: { domain_name: api.example.com, security_policy: TLS 1.2|TLS 1.0, certificate_arn: arn:aws:acm:example.com, url_prefixes: [foo, bar], tags: { key: tag1, key1: tag2 } } } } }該配置為 ApiGateway 指定了devstage。在devstage 中Chalice 會自動創(chuàng)建custom domain name并攜帶指定的url_prefixes該字段對應(yīng) AWS API Mapping key 信息。如果存在 WebSocket API應(yīng)使用websocket_api_custom_domain而不是api_gateway_custom_domain。IAM 角色與策略跨 stage 配置 IAM 策略的示例{ version: 2.0, app_name: app, stages: { dev: { autogen_policy: true, api_gateway_stage: dev }, beta: { autogen_policy: false, iam_policy_file: beta-app-policy.json }, prod: { manage_iam_role: false, iam_role_arn: arn:aws:iam::...:role/prod-role } } }該配置指定了三個 stagedev、beta、prod。在devstageChalice 會基于應(yīng)用源碼分析自動生成 IAM 策略在betastageChalice 會加載.chalice/beta-app-policy.json文件將其作為該 stage 關(guān)聯(lián)到 IAM 角色的策略在prodstageChalice 不會修改任何 IAM 角色只將 Lambda 函數(shù)的 IAM 角色設(shè)為arn:aws:iam::...:role/prod-role。下面是一個展示配置優(yōu)先級的示例{ version: 2.0, app_name: app, api_gateway_stage: api, stages: { dev: { }, beta: { }, prod: { api_gateway_stage: prod, manage_iam_role: false, iam_role_arn: arn:aws:iam::...:role/prod-role } } }該配置中dev和betastage 的 API Gateway 階段名都是api因為它們會默認(rèn)使用頂層api_gateway_stage鍵而prodstage 的 API Gateway 階段名是prod因為api_gateway_stage在{stages: {prod: ...}}映射中被單獨指定了。環(huán)境變量下面的示例同時以頂層鍵和 stage 級指定了環(huán)境變量從而既能提供所有 stage 都應(yīng)有的環(huán)境變量也能提供 stage 專屬的環(huán)境變量{ version: 2.0, app_name: app, environment_variables: { SHARED_CONFIG: foo, OTHER_CONFIG: from-top }, stages: { dev: { environment_variables: { TABLE_NAME: dev-table, OTHER_CONFIG: dev-value } }, prod: { environment_variables: { TABLE_NAME: prod-table, OTHER_CONFIG: prod-value } } } }上述配置中devstage 將設(shè)置以下環(huán)境變量{ SHARED_CONFIG: foo, TABLE_NAME: dev-table, OTHER_CONFIG: dev-value }prodstage 將設(shè)置以下環(huán)境變量{ SHARED_CONFIG: foo, TABLE_NAME: prod-table, OTHER_CONFIG: prod-value }可以看到頂層鍵SHARED_CONFIG被所有 stage 繼承而OTHER_CONFIG被 stage 級值覆蓋dev-value/prod-value。這正是 config.py 中_chain_merge實現(xiàn)的合并語義與_chain_lookup的“取第一個非空值”行為形成了鮮明對比——environment_variables與tags屬于合并型配置其余大多數(shù)配置屬于覆蓋型配置。Per Lambda 示例假設(shè)我們有如下 chalice 應(yīng)用from chalice import Chalice app Chalice(app_namedemo) app.lambda_function() def foo(event, context): pass app.lambda_function() def bar(event, context): pass針對這兩個函數(shù)我們希望實現(xiàn)如下配置目標(biāo)兩個函數(shù)都應(yīng)有環(huán)境變量OWNER值為dev-teamfoo函數(shù)應(yīng)使用由 chalice 管理的自動生成 IAM 策略foo函數(shù)應(yīng)在 VPC 中運行子網(wǎng) id 為sn-1和sn-2安全組為sg-10和sg-11且 Chalice 應(yīng)自動在 IAM 策略中加入修改 EC2 網(wǎng)絡(luò)接口的權(quán)限foo函數(shù)應(yīng)掛載兩個 Layerlayer-arn-1和layer-arn-2Chalice 應(yīng)自動配置 IAM 策略bar函數(shù)應(yīng)使用在 Chalice 之外預(yù)先創(chuàng)建的 IAM 角色Chalice 不應(yīng)對bar函數(shù)執(zhí)行 IAM 角色管理bar函數(shù)應(yīng)有環(huán)境變量TABLE_NAME值為mytable。所有這些都可以通過如下配置文件實現(xiàn){ stages: { dev: { environment_variables: { OWNER: dev-team }, api_gateway_stage: api, lambda_functions: { foo: { subnet_ids: [sn-1, sn-2], security_group_ids: [sg-10, sg-11], layers: [layer-arn-1, layer-arn-2] }, bar: { manage_iam_role: false, iam_role_arn: arn:aws:iam::my-role-name, environment_variables: {TABLE_NAME: mytable} } } } }, version: 2.0, app_name: demo }實戰(zhàn)要點總結(jié)優(yōu)先級鐵律函數(shù)級配置 stage 級配置 頂層配置 內(nèi)置默認(rèn)值config.py 的_chain_lookup與_chain_merge是實現(xiàn)核心environment_variables、tags例外——它們是逐級合并而非覆蓋。前置校驗chalice deploy前會經(jīng) validate.py 的validate_configuration做“快速失敗”校驗包括端點類型合法性、Private API 資源策略互斥規(guī)則、manage_iam_rolefalse必須有iam_role_arn、環(huán)境變量值必須為字符串、壓縮大小必須在 0~10485760 之間等。api_handler 特例所有app.route()視圖函數(shù)共享同一個名為api_handler的 Lambda函數(shù)級配置需以api_handler為鍵。配置文件的版本字段version鍵標(biāo)識配置文件 schema 版本1.0/2.0app_name必須與應(yīng)用名一致二者是部署時的必填基礎(chǔ)字段。通過本文的配置項速查表與示例組合你可以把環(huán)境差異、權(quán)限差異、網(wǎng)絡(luò)差異全部沉淀到config.json中讓同一份應(yīng)用代碼在不同 stage 上按需部署這也是 Chalice 多環(huán)境發(fā)布的最佳實踐基礎(chǔ)。相關(guān)配套文檔可繼續(xù)參閱 stages 文檔、domainname 文檔 與 packaging 文檔。贊分享后端ServerlessCLI【免費下載鏈接】chalicePython Serverless Microframework for AWS項目地址https://gitcode.com/gh_mirrors/ch/chalice點擊查看免費下載相關(guān)推薦AWS Chalice 項目如何為API配置自定義域名AWS Chalice 項目如何為API配置自定義域名 什么是自定義域名 在AWS Chalice項目中自定義域名是指為你的API提供的更簡單、更直觀的UR后端ServerlessCLI如何為Chalice API加安全鎖IAM、Cognito與自定義Authorizer完全教程如何為Chalice API加安全鎖IAM、Cognito與自定義Authorizer完全教程 Chalice 是 AWS 官方推出的 Python Serv后端ServerlessCLIXiaoMusic 配置文件方式實戰(zhàn)config.json 完整配置指南pip 安裝與 Docker Compose 部署XiaoMusic 配置文件方式實戰(zhàn)config.json 完整配置指南pip 安裝與 Docker Compose 部署 本篇技術(shù)指南面向使用小愛音箱播后端智能硬件音視頻上一篇Kor輸出格式詳解Table、JSON與YAML哪種更適合你的監(jiān)控需求下一篇OpenStatus批量導(dǎo)入監(jiān)控目標(biāo)API與CSV兩種方式對比創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考