@serverless-devs/s 2.0.92 → 2.0.93-beta.4

package/docs/zh/command/init.md

@@ -0,0 +1,148 @@
+# Init 命令
+
+`init`命令是初始化Serverless项目的脚手架。
+
+- [前言](#前言)
+- [命令解析](#命令解析)
+    - [参数解析](#参数解析)
+    - [初始化项目](#初始化项目)
+        - [引导式初始化](#引导式初始化)
+        - [直接初始化](#直接初始化)
+            - [初始化Registry应用](#初始化Registry应用)
+            - [初始化仓库应用](#初始化仓库应用)
+
+## 命令解析
+
+当执行`s init -h`之后，可以进行相关帮助信息的查看：
+
+```shell script
+$ s init -h
+Usage: s init [options] [name | url]
+
+Initialize a new project based on a template. You can initialize the application that conforms to the serverless devs project specification through GitHub, or you can initialize the application provided by the source by configuring the source.
+
+    Example:
+        $ s init
+        $ s init project
+        $ s init project -d my_dir
+        $ s init git@github.com:foo/bar.git
+        $ s init https://github.com/foo/bar.git
+        
+🚀 More Application: https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/awesome.md
+
+Options:
+  -d, --dir [dir]       Where to output the initialized app into (default: ./<ProjectName> )
+  -r, --registry [url]  Use specify registry
+  -h, --help            Display help for command
+```
+
+### 参数解析
+
+| 参数全称 | 参数缩写 | 默认取值 | 参数含义 |
+|-----|-----|-----|-----|
+| dir | d | `./<ProjectName>` | 项目初始化的路径/目录 | 
+| registry | -r | http://registry.devsapp.cn/simple | 源配置地址，类似于Python中指定pip源，或者Node.js中指定NPM源 | 
+
+### 初始化项目
+
+#### 引导式初始化
+
+通过`s init`可以直接进入项目初始化的引导模块：
+
+```shell script
+$ s init
+
+🚀 Serverless Awesome: https://github.com/Serverless-Devs/package-awesome
+
+? Hello Serverless for Cloud Vendors (Use arrow keys or type to search)
+❯ Alibaba Cloud Serverless 
+  AWS Cloud Serverless 
+  Baidu Cloud Serverless 
+  Huawei Cloud Serverless 
+  Tencent Cloud Serverless 
+  Dev Template for Serverless Devs 
+```
+
+此时只需要选择对应的选项，按照引导进行操作，即可。例如选择`Alibaba Cloud Serverless`，就可以看到阿里云Serverless产品下的应用模板分类:
+
+```shell script
+? Please select an Serverless-Devs Application (Use arrow keys or type to search)
+❯ fc-runtime-starter - 快速部署一个 FC 函数 
+  fc-custom-container-stater - 快速部署一个 custom-container 应用 
+  web-framework-stater - 快速部署一个 Web 框架 
+  static-website-stater - 快速部署一个静态网站 
+  serverless-best-practice - 快速体验 Serverless 最佳实践 
+```
+
+此时可以继续选择某分类下的具体应用进行初始化，例如选择`fc-runtime-starter`之后，可以看到该分类下的具体模板应用：
+
+```shell script
+? Please select an templete (Use arrow keys or type to search)
+❯ fc-http-nodejs - 快速部署一个 nodejs12 http函数 
+  fc-http-python - 快速部署一个 python3 http函数 
+  fc-http-php - 快速部署一个 php http函数 
+  fc-http-java - 快速部署一个 java8 http函数 
+  fc-event-nodejs - 快速部署一个 nodejs12 event函数 
+  fc-event-python - 快速部署一个 python3 event函数 
+  fc-event-php - 快速部署一个 php event函数 
+```
+
+选择`fc-http-nodejs`即可完成创建：
+
+```shell script
+jiangyu@ServerlessSecurity demo % s init                                         
+
+🚀 Serverless Awesome: https://github.com/Serverless-Devs/package-awesome
+
+? Hello Serverless for Cloud Vendors Alibaba Cloud Serverless
+? Please select an Serverless-Devs Application fc-runtime-starter - 快速部署一个 FC 函数
+? Please select an templete fc-http-nodejs - 快速部署一个 nodejs12 http函数
+
+......
+
+💞 Document ❤ Star：https://github.com/Serverless-Devs/Serverless-Devs
+```
+
+更多关于默认源对应的应用信息，可以参考[Package Awesome](https://github.com/Serverless-Devs/package-awesome)
+
+#### 直接初始化
+
+通过`s init [name | url]`，可以从配置的`Registry`或者指定的仓库`Url`获取模板项目。
+
+##### 初始化Registry应用
+
+以默认的`Registry`为例，可以初始化相对应的案例项目：`start-fc-http-nodejs12`，可以通过`s init start-fc-http-nodejs12`命令来进行：
+
+```shell script
+$ s init start-fc-http-nodejs12
+
+🚀 Serverless Awesome: https://github.com/Serverless-Devs/package-awesome
+
+? Please input your project name (init dir) start-fc-http-nodejs12
+✔ file decompression completed
+
+......
+
+💞 Document ❤ Star：https://github.com/Serverless-Devs/Serverless-Devs
+```
+
+##### 初始化仓库应用
+
+以Github仓库 `https://github.com/devsapp/puppeteer-app` 为例，可以通过`s init git@github.com:devsapp/puppeteer-app.git`命令初始化该案例项目：
+
+```shell script
+$ s init git@github.com:devsapp/puppeteer-app.git
+
+🚀 Serverless Awesome: https://github.com/Serverless-Devs/package-awesome
+
+Cloning into 'puppeteer-app'...
+remote: Enumerating objects: 35, done.
+remote: Counting objects: 100% (35/35), done.
+remote: Compressing objects: 100% (23/23), done.
+remote: Total 35 (delta 10), reused 30 (delta 6), pack-reused 0
+Receiving objects: 100% (35/35), 6.59 KiB | 3.30 MiB/s, done.
+Resolving deltas: 100% (10/10), done.
+```
+
+
+

package/docs/zh/command/readme.md

@@ -0,0 +1,76 @@
+# 命令操作文档
+
+- [前言](#前言)
+- [全局参数](#全局参数)
+- [命令详情](#命令详情)
+    - [config: 密钥配置](./config.md)
+    - [init: 项目初始化](./init.md)
+    - [cli: 纯命令行模式](./cli.md)
+    - [clean: 工具清理](./clean.md)
+    - [component: 组件信息](./component.md)
+    - [set: 工具配置](./set.md)
+    - [custom: 自定义命令](./custom.md)
+
+## 前言
+
+Serverless Devs 可以通过`-h`唤起对应命令的帮助文档，例如查看 `s` 命令的帮助信息可以是：`s -h`
+
+当使用者使用命令行工具时，可以通过`s`命令，查看整体帮助信息:
+
+```shell script
+$ s
+Usage: s [options] [command]
+
+  _________                               .__
+ /   _____/ ______________  __ ___________|  |   ____   ______ ______
+ \_____  \_/ __ \_  __ \  \/ // __ \_  __ \  | _/ __ \ /  ___//  ___/
+ /        \  ___/|  | \/\   /\  ___/|  | \/  |_\  ___/ \___ \ \___ \
+/_________/\_____>__|    \_/  \_____>__|  |____/\_____>______>______>
+
+Welcome to the Serverless Devs.
+
+More: 
+📘 Documents: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs
+🙌 Discussions: https://github.com/Serverless-Devs/Serverless-Devs/discussions
+📦 Applications: https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/awesome.md
+
+Quick start:
+🍻 Can perform [s init] fast experience
+
+Options:
+  -t, --template [templatePath]  Specify the template file
+  -a, --access [aliasName]       Specify the access alias name
+  --skip-actions                 Skip the extends section
+  --debug                        Open debug model
+  -v, --version                  Output the version number
+  -h, --help                     Display help for command
+
+Commands:
+  config                         👤 Configure venders account.
+  init                           💞 Initializing a serverless project.
+  cli                            🐚 Command line operation without yaml mode.
+  set                            🔧 Settings for the tool.
+  clean                          💥 Clean up the environment.
+  component                      🔌 Installed component information.
+```
+
+## 全局参数
+
+| 参数全称 | 参数缩写 | 默认取值 | 参数含义 | 备注 |
+|-----|-----|-----|-----|-----|
+| template | t | `s.yaml`/`s.yml` | 指定资源描述文件 | 可选`yaml`和`JSON`两种格式 | 
+| access | a | `yaml`中所指定的`access`信息/`default` | 指定本次部署时的密钥信息 | 可以使用通过[config命令](./command/config.md#config-add-命令)配置的密钥信息，以及[配置到环境变量的密钥信息](./command/config.md#通过环境变量配置密钥信息) | 
+| skip-actions | - | - | 跳过`yaml`所设置的`actions`模块 | - | 
+| debug | - | - | 开启`Debug`模式 | 开启`Debug`模式后可以查看到更多的工具执行过程信息 | 
+| version | v | - | 查看版本信息 | - | 
+| help | h | - | 查看帮助信息 | - | 
+
+## 命令详情
+
+- [config: 密钥配置](./config.md)
+- [init: 项目初始化](./init.md)
+- [cli: 纯命令行模式](./cli.md)
+- [clean: 工具清理](./clean.md)
+- [set: 工具配置](./set.md)
+- [component: 组件信息](./component.md)
+- [custom: 自定义命令](./custom.md)

package/docs/zh/command/set.md

@@ -0,0 +1,195 @@
+# Set 命令
+
+`set`命令是对工具进行相关配置的命令。
+
+- [命令解析](#命令解析)
+- [set registry 命令](#set-registry-命令)
+- [set locale 命令](#set-locale-命令)
+- [[FEATURE] set analysis 命令](#feature-set-analysis-命令)
+- [[FEATURE] set workspace 命令](#feature-set-workspace-命令)
+
+## 命令解析
+
+当执行`s set -h`之后，可以进行相关帮助信息的查看：
+
+```shell script
+$ s set -h
+Usage: s set [commands] [options]
+
+You can make some default settings for the tool here.
+
+📖 Document: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs/zh/command/set.md
+
+Options:
+  -h, --help  Display help for command
+
+Commands:
+  registry    👀 Set up a custom registry
+  locale      🔧 Set up current language
+  analysis    👉 Set to enable or disable analysis
+```
+
+在该命令中，包括了三个子命令：
+- [registry：配置 Serverless Devs 所使用的 registry](#set-registry-命令)
+- [locale：配置 Serverless Devs 所默认的语言](#set-locale-命令)
+- [analysis：配置 Serverless Devs 所进行的数据分析行为](#set-analysis-命令)
+
+
+## set registry 命令
+
+通过该命令，可以对 Serverless Devs 开发者工具进行 Registry 配置。 
+
+执行`s set registry -h`命令，可以看到帮助文档
+
+```shell script
+$ s set registry -h
+
+Usage: s set registry [options]
+
+Set registry information.
+
+    Example:
+        $ s set registry
+        $ s set registry http://registry.devsapp.cn/simple
+
+Options:
+  -h, --help  Display help for command
+```
+
+切换 Registry 的方法有两种：
+1. 直接提供 Registry 信息，例如：`s set registry http://registry.devsapp.cn/simple`
+2. 通过交互式方法，进行 Registry 信息的切换：
+    ```shell script
+    $ s set registry
+    
+    🔎 Current registry: http://registry.devsapp.cn/simple
+    
+    ? Choose a registry? (Use arrow keys)
+    ❯ serverless registry [http://registry.devsapp.cn/simple] 
+      github registry [https://api.github.com/repos]
+      gitee registry [http://gitee.registry.devsapp.cn/simple]
+      custom registry 
+    ```
+    此时，只需要选择对应的选项，就可以引导式的进行操作。
+
+> 额外需要说明的是，虽然社区目前拥有Github Resitry， Gitee Registry， Serverless Registry等三个源，但是实际上这三个源也有着一定的逻辑关系：
+> - Github Resitry：终极默认源，即无论用户配置了其他任何一个源，如果没有找到对应的内容，都会默认到该源进行查找；
+> - Gitee Registry：针对中国用户，与Gitee合作的国内源；
+> - Serverless Registry：Serverless Devs社区的默认源，也将作为被默认配置的源；
+> 在Serverless Devs的开发者工具中，默认的加载逻辑：   
+> ![图片alt](https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635132866484_20211025033426634967.png)
+
+> 🙊 注：系统默认的 Registry 是：`serverless devs offical registry [http://registry.devsapp.cn/simple] `
+
+## set locale 命令
+
+通过该命令，可以对 Serverless Devs 开发者工具的语言进行配置。 
+
+执行`s set locale -h`命令，可以看到帮助文档
+
+```shell script
+$ s set locale -h
+
+Usage: s set locale [options]
+
+Set language information.
+
+    Example:
+        $ s set locale
+        $ s set locale zh
+
+Options:
+  -h, --help  Display help for command
+```
+
+设置 locale 的方法有两种：
+1. 直接提供语言缩写，例如：`s set locale zh`
+2. 通过交互式方法，进行语言信息的切换：
+    ```shell script
+    $ s set locale
+    
+    💬 Current language: 中文（zh）
+    
+    ? Choose a language? (Use arrow keys)
+    ❯ 中文（zh）
+      English（en）
+    ```
+    此时，只需要选择对应的选项，就可以引导式的进行操作。
+
+> 🙊 注：系统默认的 locale 是：`zh`
+
+## [FEATURE] set analysis 命令
+
+通过该命令，可以对 Serverless Devs 开发者工具的数据分析能力进行配置。  
+
+执行`s set analysis -h`命令，可以看到帮助文档
+
+```shell script
+$ s set analysis -h
+
+Usage: s set analysis [options]
+
+Set analysis action.
+
+    Example:
+        $ s set analysis
+        $ s set analysis disable
+
+Options:
+  -h, --help  Display help for command
+```
+
+设置 analysis 的方法有两种：
+1. 直接进行配置，例如：`s set analysis disable`
+2. 通过交互式方法，进行配置：
+    ```shell script
+    $ s set analysis
+    
+    📝 Current analysis action: enable
+    
+    ? Choose a action? (Use arrow keys)
+    ❯ enable
+      disable
+    ```
+    此时，只需要选择对应的选项，就可以引导式的进行操作。
+
+> 🙊 注：系统默认的 analysis 是：`enable`
+
+## [FEATURE] set workspace 命令
+
+通过该命令，可以对 Serverless Devs 开发者工具的默认路径进行配置。 
+
+执行`s set workspace -h`命令，可以看到帮助文档
+
+```shell script
+$ s set workspace -h
+
+Usage: s set workspace [options]
+
+Set workspace path. Switching workspaces may make previously cached components and configured key information unavailable.
+
+    Example:
+        $ s set workspace
+        $ s set workspace ~/.s
+
+Options:
+  -h, --help  Display help for command
+```
+
+设置 workspace 的方法有两种：
+1. 直接进行配置，例如：`s set workspace ~/.s`
+2. 通过交互式方法，进行配置：
+    ```shell script
+    $ s set workspace
+    
+    📝 Current workspace path: ~/.s
+    
+    🙊 Switching workspaces may make previously cached components and configured key information unavailable.
+     
+    ? Please input an absolute path: 
+    ```
+    此时，只需要选择对应的选项，就可以引导式的进行操作。
+
+
+
+> 🙊 注：系统默认的 workspace 是：`~/.s`

package/docs/zh/default_provider_config/alibabacloud.md

@@ -0,0 +1,82 @@
+# 阿里云密钥获取
+
+阿里云官网：https://www.aliyun.com   
+AccountId获取页面：https://account.console.aliyun.com/#/secure   
+获取密钥页面：https://usercenter.console.aliyun.com/#/manage/ak
+
+- 打开 [AccountId获取页面](https://account.console.aliyun.com/#/secure) 获取AccountId ：
+  ![AccountId获取页面](https://images.devsapp.cn/access/aliyun-accountid.jpg)
+
+- 打开 [获取密钥页面](https://usercenter.console.aliyun.com/#/manage/ak) 获取密钥信息 ：
+  ![获取密钥页面](https://images.devsapp.cn/access/aliyun-access.jpg)
+ 
+  
+> 云账号 AccessKey 是您访问阿里云 API 的密钥，具有该账户完全的权限，请您务必妥善保管！不要通过任何方式（e.g. Github）将 AccessKey 公开到外部渠道，以避免被他人利用而造成 [安全威胁](https://help.aliyun.com/knowledge_detail/54059.html?spm=5176.2020520153.0.0.57f1336a8PQ1KR) 。    
+> 强烈建议您遵循 [阿里云安全最佳实践](https://help.aliyun.com/document_detail/102600.html?spm=5176.2020520153.0.0.57f1336a8PQ1KR) ，使用 RAM 子用户 AccessKey 来进行 API 调用。
+
+----
+
+## 安全建议
+
+- 创建独立的RAM用户   
+企业只需使用一个云账号。通过RAM为名下的不同操作员创建独立的RAM用户，进行分权管理，不使用云账号进行日常运维管理。
+
+  详情请参见[创建RAM用户](https://help.aliyun.com/document_detail/93720.html?spm=a2c4g.11186623.2.15.c79a1723Vwyvig#task-187540) 。
+
+- 将控制台用户与API用户分离    
+  不建议给一个RAM用户同时创建用于控制台操作的登录密码和用于API操作的访问密钥。
+
+  应用程序账号：只需要通过OpenAPI访问云资源，创建访问密钥即可。   
+  员工账号：只需要通过控制台操作云资源，设置登录密码即可。      
+  详情请参见[创建RAM用户](https://help.aliyun.com/document_detail/93720.html?spm=a2c4g.11186623.2.16.c79a1723Vwyvig#task-187540) 。
+
+- 创建用户并进行分组   
+  当云账号下有多个RAM用户时，可以通过创建用户组对职责相同的RAM用户进行分类并授权。   
+
+  详情请参见[创建用户组](https://help.aliyun.com/document_detail/93724.html?spm=a2c4g.11186623.2.17.c79a1723Vwyvig#task-187540) 。
+
+- 给不同用户组分配最小权限   
+  您可以使用系统策略为用户或用户组绑定合理的权限策略，如果您需要更精细粒度的权限策略，也可以选择使用自定义策略。通过为用户或用户组授予最小权限，可以更好的限制用户对资源的操作权限。   
+
+  详情请参见[创建自定义策略](https://help.aliyun.com/document_detail/93733.html?spm=a2c4g.11186623.2.18.c79a1723Vwyvig#task-glf-vwf-xdb) 。
+
+- 为用户登录配置强密码策略   
+  您可以通过RAM控制台设置密码策略，如密码长度、密码中必须包含元素、密码有效期等。如果允许RAM用户更改登录密码，那么应该要求RAM用户创建强密码并且定期轮换登录密码或访问密钥。   
+
+  详情请参见[设置RAM用户安全策略](https://help.aliyun.com/document_detail/116414.html?spm=a2c4g.11186623.2.19.c79a1723Vwyvig#task-188786) 。
+
+- 为云账号开启多因素认证    
+  开启多因素认证（Multi-factor authentication，MFA）可以提高账号的安全性，在用户名和密码之外再增加一层安全保护。启用MFA后，用户登录阿里云时，系统将要求输入两层安全要素：   
+
+  第一安全要素：用户名和密码   
+  第二安全要素：多因素认证设备生成的验证码   
+  详情请参见[为云账号设置多因素认证](https://help.aliyun.com/document_detail/28635.html?spm=a2c4g.11186623.2.20.c79a1723Vwyvig#task-u2b-ww2-xdb) 。
+
+- 为用户开启SSO单点登录功能    
+  开启SSO单点登录后，企业内部账号进行统一的身份认证，实现使用企业本地账号登录阿里云才能访问相应资源。   
+
+  详情请参见[SSO概览](https://help.aliyun.com/document_detail/93684.html?spm=a2c4g.11186623.2.21.c79a1723Vwyvig#concept-etn-fjc-mfb) 。
+
+- 不要为云账号创建访问密钥     
+  由于云账号对名下资源有完全控制权限，AccessKey与登录密码具有同样的权力，AccessKey用于程序访问，登录密码用于控制台登录。为了避免因访问密钥泄露带来的信息泄露，不建议您创建云账号访问密钥并使用该密钥进行日常工作。   
+
+  您可以通过为RAM用户创建访问密钥，使用RAM用户进行日常工作。   
+
+  详情请参见[为RAM用户创建访问密钥](https://help.aliyun.com/document_detail/116401.html?spm=a2c4g.11186623.2.22.c79a1723Vwyvig#task-188766) 。
+
+- 使用策略限制条件来增强安全性    
+  要求用户必须使用安全信道（例如：SSL）、在指定时间范围或在指定源IP条件下才能操作指定的云资源。   
+
+  详情请参见[权限策略基本元素](https://help.aliyun.com/document_detail/93738.html?spm=a2c4g.11186623.2.23.c79a1723Vwyvig#concept-xg5-51g-xdb) 。
+  
+- 集中控制云资源    
+  阿里云默认云账号是资源的拥有者，掌握完全控制权。RAM用户对资源只有使用权，没有所有权。这一特性可以方便您对用户创建的实例或数据进行集中控制。   
+
+  当用户离开组织：只需要将对应的账号移除，即可撤销所有权限。   
+  当用户加入组织：只需创建新的账号，设置登录密码或访问密钥并为RAM用户授权。   
+  详情请参见为[RAM用户授权](https://help.aliyun.com/document_detail/116146.html?spm=a2c4g.11186623.2.24.c79a1723Vwyvig#task-187800) 。
+
+- 使用STS给用户授权临时权限   
+  STS （Security Token Service）是RAM的一个扩展授权服务，使用STS访问令牌可以给用户授予临时权限，您可以根据需要来定义访问令牌的权限和自动过期时间，可以让授权更加可控。   
+
+  详情请参见[什么是STS](https://help.aliyun.com/document_detail/28756.html?spm=a2c4g.11186623.2.25.c79a1723Vwyvig#concept-ong-5nv-xdb) 。

package/docs/zh/default_provider_config/aws.md

@@ -0,0 +1,12 @@
+# AWS密钥获取
+
+AWS官网：https://www.AWS.com       
+
+- 打开 [AWS官网](https://www.AWS.com) 进行登录，登录后选择右上角【我的凭证】：
+  ![获取密钥页面](https://images.devsapp.cn/access/aws-page.jpg)
+- 点击【访问密钥】，并且【创建新的访问密钥】：
+  ![](https://images.devsapp.cn/access/aws-create.jpg)
+- 完成之后即可看到密钥详情：
+  ![](https://images.devsapp.cn/access/aws-access.jpg)
+
+> 为帮助保护您的安全，请妥善保存私有访问密钥，切勿与他人共享。

package/docs/zh/default_provider_config/azure.md

@@ -0,0 +1,9 @@
+# Azure密钥获取
+
+Azure官网：https://www.azure.com       
+
+- 通过 [Azure网](https://portal.azure.com/) 进入所创建的Azure Web App的管理界面之后进入Identity管理界面
+- 在Azure网站最上方的搜索栏里搜索Key Vault关键字并进入Key Vault管理总界面
+   ![](https://images.devsapp.cn/access/azure-page.jpg)
+- 点击进入创建好的Azure Key Vault实例之后进入Access Policies管理界面
+- 击添加访问策略按钮，为需要授权的principal添加权限后点击保存按钮即可

package/docs/zh/default_provider_config/baiducloud.md

@@ -0,0 +1,8 @@
+# 百度云密钥获取
+
+百度云官网：https://cloud.baidu.com/        
+
+- 打开 [百度云官网](https://cloud.baidu.com/) 进行登录，登录后选择右上角安全认证 ：
+  ![获取密钥页面](https://images.devsapp.cn/access/baidu-login.jpg)
+- 点击Access Key ID右侧的“显示”，可查看其对应的Secret Access Key，点击“隐藏”可隐藏对应的Secret Access Key: 
+  ![获取密钥](https://images.devsapp.cn/access/baidu-access.jpg)

package/docs/zh/default_provider_config/gcp.md

@@ -0,0 +1,21 @@
+# Google Cloud密钥获取
+
+Google Cloud官网：https://cloud.google.com       
+
+- 打开 [Google Cloud官网](https://cloud.google.com) 进行登录，选择对应项目，进入到项目中：
+  ![获取密钥页面](https://images.devsapp.cn/access/google-console.jpg)
+- 点击左侧的【服务账号】：
+  ![](https://images.devsapp.cn/access/google-service.jpg)
+- 再点击上面的【创建服务账号】：
+  ![](https://images.devsapp.cn/access/google-add.jpg)
+- 创建完成会下载对应文件】：
+  ![](https://images.devsapp.cn/access/google-access.jpg)
+- 将该文件存储到本地，并将存储的绝对路径配置到`s`工具所需的`PrivateKeyData`中
+
+> 当您在应用中使用 API 密钥时，请确保其在存储和传输期间均安全无虞。公开泄露凭据可能会导致您的帐号遭盗用，这可能会使您的帐号产生预料之外的费用。为帮助确保 API 密钥的安全，请遵循以下最佳做法：
+> - 不要直接在代码中嵌入 API 密钥。嵌入代码中的 API 密钥可能会被意外泄露给公众。例如，您可能忘记从共享的代码中移除密钥。您可以将 API 密钥存储在环境变量或应用的源代码树之外的文件中，而不是将 API 密钥嵌入应用中。
+> - 不要将 API 密钥存储在应用的源代码树内的文件中。如果将 API 密钥存储在文件中，请将文件保留在应用的源代码树之外，这有助于确保密钥最终不会进入源代码控制系统。 如果您使用公共源代码管理系统（如 GitHub），这种做法尤为重要。
+> - 设置应用和 [API 密钥限制](https://cloud.google.com/docs/authentication/api-keys#api_key_restrictions) 。 通过添加限制，您可以降低 API 密钥被盗用时造成的影响。
+> - 删除不需要的 API 密钥以最大限度地减少遭到攻击的风险。
+> - 定期重新生成 API 密钥。您可以在[“凭据”页面](https://console.cloud.google.com/apis/credentials?_ga=2.119850376.1642904664.1603769673-1032325965.1594091682) 中，针对每个密钥点击重新生成密钥，从而重新生成 API 密钥。然后，更新您的应用以使用新生成的密钥。生成替换密钥后，旧密钥将在 24 小时后失效。
+> - 公开发布代码前，先检查您的代码，确保您的代码不包含 API 密钥或任何其他私密信息，然后再公开代码。

package/docs/zh/default_provider_config/huaweicloud.md

@@ -0,0 +1,52 @@
+# 华为云密钥获取
+
+华为云官网：https://www.huaweicloud.com/       
+
+- 打开 [华为云官网](https://www.huaweicloud.com/) 进行登录，登录后选择右上角【我的凭证】再选择左侧的 【访问密钥】：
+  ![获取密钥页面](https://images.devsapp.cn/access/huawei-page.jpg)
+- 点击新增访问密钥，会弹出提示框进行相关安全验证，通过之后可以看到：
+  ![](https://images.devsapp.cn/access/huawei-download.jpg)
+- 下载之后可以看到自己的密钥信息：
+  ![](https://images.devsapp.cn/access/huawei-access.jpg)
+
+> 如果访问密钥泄露，会带来数据泄露风险，且每个访问密钥仅能下载一次，为了账号安全性，建议您定期更换并妥善保存访问密钥。
+
+------
+
+## 安全建议
+
+- 不给华为云账号创建访问密钥   
+华为云账号是您华为云资源归属、资源使用计费的主体，对其所拥有的资源及云服务具有完全的访问权限。密码与访问密钥（AK/SK）都是账号的身份凭证，具有同等效力，密码用于登录界面控制台，是您必须具备的身份凭证，访问密钥用于使用开发工具进行编程调用，是第二个身份凭证，为辅助性质，非必须具备。为了提高账号安全性，建议您仅使用密码登录控制台即可，不要给账号创建第二个身份凭证（访问密钥），避免因访问密钥泄露带来的信息安全风险。
+
+- 不将访问密钥嵌入到代码中   
+当您使用API、CLI、SDK等开发工具来访问云服务时，请勿直接将访问密钥嵌入到代码中，减少访问密钥被泄露的风险。
+
+- 创建单独的IAM用户   
+如果有任何人需要访问您华为云账号中的资源，请不要将账号的密码共享给他们，而是在您的账号中给他们创建单独的IAM用户并分配相应的权限，同时，作为华为云账号主体，建议您不使用账号访问华为云，而是为自己创建一个IAM用户，并授予该用户管理权限，以使用该IAM用户代替账号进行日常管理工作，保护账号的安全。
+
+- 授予最小权限   
+最小权限原则是标准的安全建议，您可以使用IAM提供的系统权限，或者自己创建自定义策略，给账号中的用户仅授予刚好能完成工作所需的权限，通过最小权限原则，可以帮助您安全地控制用户对华为云资源的访问。
+
+   同时，建议为使用API、CLI、SDK等开发工具访问云服务的IAM用户，授予自定义策略，通过精细的权限控制，减小因访问密钥泄露对您的账号造成的影响。
+
+- 开启虚拟MFA功能   
+Multi-Factor Authentication (简称MFA) 是一种非常简单的安全实践方法，建议您给华为云账号以及您账号中具备较高权限的用户开启MFA功能，它能够在用户名和密码之外再额外增加一层保护。启用MFA后，用户登录控制台时，系统将要求用户输入用户名和密码（第一安全要素），以及来自其MFA设备的验证码（第二安全要素）。这些多重要素结合起来将为您的账户和资源提供更高的安全保护。    
+
+   MFA设备可以基于硬件也可以基于软件，系统目前仅支持基于软件的虚拟MFA，虚拟MFA是能产生6位数字认证码的应用程序，此类应用程序可在移动硬件设备（包括智能手机）上运行，非常方便。
+
+- 设置强密码策略   
+在IAM控制台设置强密码策略，例如密码最小长度、密码中同一字符连续出现的最大次数、密码不能与历史密码相同，保证用户使用复杂程度高的强密码。
+
+- 设置敏感操作    
+设置敏感操作后，如果您或者您账号中的用户进行敏感操作时，例如删除资源、生成访问密钥等，需要输入密码和验证码进行验证，避免误操作带来的风险和损失。    
+
+- 定期修改身份凭证   
+如果您不知道自己的密码或访问密钥已泄露，定期进行修改可以将不小心泄露的风险降至最低。
+
+   定期轮换密码可以通过设置密码有效期策略进行，您以及您账号中的用户在设置的时间内必须修改密码，否则密码将会失效，IAM会在密码到期前15天开始提示用户修改密码。    
+   轮换访问密钥可以通过创建两个访问密钥进行，将两个访问密钥作为一主一备，一开始先使用主访问密钥一，一段时间后，使用备访问密钥二，然后在控制台删除主访问密钥一，并重新生成一个访问密钥，在您的应用程序中定期轮换使用。    
+
+- 删除不需要的身份凭证   
+   对于仅需要登录控制台的IAM用户，不需要使用访问密钥，请不要给他们创建，或者及时删除访问密钥。您还可以通过账号中IAM用户的“最近一次登录时间”，来判断该用户的凭证是否已经属于不需要的范畴，对于长期未登录的用户，请及时修改他们的身份凭证，包括修改密码和删除访问密钥，您还可以设置“账号停用策略”来控制长期未使用的账号到期自动停用。
+
+

package/docs/zh/default_provider_config/readme.md

@@ -0,0 +1,9 @@
+# 云厂商密钥配置
+
+- [阿里云](alibabacloud.md)
+- [百度云](baiducloud.md)
+- [AWS](aws.md)
+- [Azure](azure.md)
+- [Google Cloud](gcp.md)
+- [华为云](huaweicloud.md)
+- [腾讯云](tencentcloud.md)

package/docs/zh/default_provider_config/tencentcloud.md

@@ -0,0 +1,41 @@
+# 腾讯云密钥获取
+
+腾讯云官网：https://cloud.tencent.com/    
+获取密钥页面：https://console.cloud.tencent.com/cam/capi
+
+- 打开 [获取密钥页面](https://console.cloud.tencent.com/cam/capi) 获取密钥 ：
+  ![获取密钥页面](https://images.devsapp.cn/access/tencent-access.jpg)
+
+
+> 使用主账号密钥可以无限制地访问您的腾讯云资源，主账号密钥泄露可能造成您的云上资产损失！强烈建议您参照 [最佳实践](https://cloud.tencent.com/document/product/598/10592) 停止使用主账号登录控制台或者使用主账号密钥访问云API，请使用子账号进行相关资源操作。 [如何创建子用户](https://cloud.tencent.com/document/product/598/13674)
+
+------
+
+## 安全建议
+
+- 开启 MFA 保护    
+  为增强账号安全性，建议您为所有账号绑定 MFA；为主账号及子账号都开启登录保护和敏感操作保护。对于支持邮箱登录或者微信登录的强烈推荐进行 MFA 二次验证。开启 MFA 后，账号登录及敏感操作需进行二次校验。相关设置请参考：[为协作者设置安全保护](https://cloud.tencent.com/document/product/598/36626) 、[为子用户设置安全保护](https://cloud.tencent.com/document/product/598/36383) 。
+
+- 使用子账号访问腾讯云    
+  请尽量不要使用主账号的身份凭证访问腾讯云，更不要将身份凭证共享给他人。一般情况下，应该为所有访问腾讯云的用户创建子账号，同时授权该子账号相应的管理权限。相关设置请参考：[用户类型](https://cloud.tencent.com/document/product/598/13665) 。
+
+- 使用组给子账号分配权限    
+  按照工作职责定义好组，并给组分配相应的管理权限。然后把用户分配到对应的组里。这样，当您修改组的权限时，组里相关用户的权限随即发生变更。另外，当组织架构发生调整时，只需要更新用户和组的关系即可。相关设置请参考：[用户组](https://cloud.tencent.com/document/product/598/14985) 。
+
+- 最小权限原则    
+  最小权限原则是一项标准的安全原则。即仅授予执行任务所需的最小权限，不要授予更多无关权限。例如，一个用户仅是 CDN 服务的使用者，那么不需要将其他服务的资源访问权限（如 COS 读写权限）授予给该用户。
+
+- 分子账号管理用户、权限和资源    
+  建议同一个子账号不同时管理用户、权限和资源。应该让部分子账户管理用户，部分子账号管理权限，部分子账号管理其他云资源。
+
+- 定期轮转身份凭证      
+  建议您或 CAM 用户要定期轮换登录密码或云 API 密钥。这样可以让身份凭证泄漏情况下的影响时间受限。   
+  主账号密码设置请参考：[账号密码](https://cloud.tencent.com/document/product/378/14623) 。     
+  子用户密码设置请参考：[子用户重置密码](https://cloud.tencent.com/document/product/598/36260) 。      
+
+- 删除不需要的证书和权限      
+  删除用户不需要的证书以及用户不再需要的权限。尽量减少访问凭证泄漏后带来的安全风险。
+
+- 使用策略条件来增强安全性     
+尽可能的为策略定义更精细化的条件，约束策略生效的场景，强化安全性。如约束用户必须在指定的时间，指定的服务器上执行某些操作等。   
+  相关设置请参考：[元素参考 condition](https://cloud.tencent.com/document/product/598/10603#6.-.E7.94.9F.E6.95.88.E6.9D.A1.E4.BB.B6.EF.BC.88condition.EF.BC.89) 。