doc: setup-s

Serverless-Devs · Feb 26, 2024 · 5835ae8 · 5835ae8
1 parent 1dbadb2
commit 5835ae8
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -12,24 +12,49 @@ steps:
     id: checkout
     uses: actions/checkout@v4
 
-  - name: Setup Serverless-devs
-    uses: actions/setup-s-aliyun@v1
+  - name: Setup Serverless-devs for aliyun
+    uses: actions/setup-s@v1
     with:
+      provider: aliyun
+      version: 3.0.2
       account_id: ${{ secrets.ACCOUNT_ID }}
       access_key_id: ${{ secrets.ACCESS_KEYID }}
       access_key_secret: ${{ secrets.ACCESS_KEYSECRET }}
-      access: default
-      version: v3.0.0
+      access: aliyun_access
+
+  - name: Setup Serverless-devs for aws
+    uses: actions/setup-s@v1
+    with:
+      provider: aws
+      # version: 3.0.0
+      access_key_id: ${{ secrets.ACCESS_KEYID }}
+      secret_access_key: ${{ secrets.SECRET_ACCESSKEY }}
+      access: aws_access
+
 ```
 
 ## 参数说明
 | 字段 |  说明   | 类型 |  默认值  |
 | ----- |  -------- | ---- | ---|
-| account_id |   必填，阿里云账号ID  |   string   | - |
-| access_key_id  | 必填，阿里云AK |  string    | - |
-| access_key_secret  | 必填，阿里云SK |   string   | - |
-| access  | 非必填，密钥别名 |  string  | default |
-| version | 非必填，安装版本 |  v3.0.0  | v3.0.0 |
+| provider |   必填，云厂商名称  |   string   | - |
+| account_id |   部分厂商账号ID  |   string   | - |
+| access_key_id  | 部分厂商账号AK |  string    | - |
+| access_key_secret  | 部分厂商账号SK |   string   | - |
+| secret_access_key  | 部分厂商账号SK |   string   | - |
+| secret_id  | 部分厂商账号AK |   string   | - |
+| secret_key  | 部分厂商账号SK |   string   | - |
+| access  | 密钥别名 |  string  | default |
+| version | 非必填，安装版本 |  3.0.0  | 3.0.0 |
+
+
+密钥相关说明详见 [Serverless-devs 文档](https://docs.serverless-devs.com/serverless-devs/default_provider_config#%E9%98%BF%E9%87%8C%E4%BA%91%E5%AF%86%E9%92%A5%E8%8E%B7%E5%8F%96)。
+
 
+## 常见云厂商密钥配置内容
 
-密钥相关说明详见 [Serverless-devs 文档](https://docs.serverless-devs.com/serverless-devs/default_provider_config#%E9%98%BF%E9%87%8C%E4%BA%91%E5%AF%86%E9%92%A5%E8%8E%B7%E5%8F%96)。
+| 云厂商 | 类型 |
+| --- | --- |
+| alibaba |    AccountID, AccessKeyID, AccessKeySecret |
+| aws |        AccessKeyID, SecretAccessKey|
+| huawei |     AccessKeyID, SecretAccessKey|
+| tencent |    AccountID, SecretID, SecretKey|
diff --git a/README_en.md b/README_en.md
@@ -12,23 +12,52 @@ steps:
     id: checkout
     uses: actions/checkout@v4
 
-  - name: Setup Serverless-devs
-    uses: actions/setup-s-aliyun@v1
+  - name: Setup Serverless-devs for aliyun
+    uses: actions/setup-s@v1
     with:
+      provider: aliyun
+      version: 3.0.2
       account_id: ${{ secrets.ACCOUNT_ID }}
       access_key_id: ${{ secrets.ACCESS_KEYID }}
       access_key_secret: ${{ secrets.ACCESS_KEYSECRET }}
-      access: default
-      version: v3.0.0
+      access: aliyun_access
+
+  - name: Setup Serverless-devs for aws
+    uses: actions/setup-s@v1
+    with:
+      provider: aws
+      # version: 3.0.0
+      access_key_id: ${{ secrets.ACCESS_KEYID }}
+      secret_access_key: ${{ secrets.SECRET_ACCESSKEY }}
+      access: aws_access
+
 ```
 
 ## Params
-| Property |   Description   | Type | Default |
+| Property |  Description   | Type |  Default  |
 | ----- |  -------- | ---- | ---|
-| account_id |   required，Aliyun account ID  | string |-|
-| access_key_id  | required，Aliyun AK |  string  | - |
-| access_key_secret  | required，Aliyun SK | string | - |
-| access  | aceess alias | string | default |
-| version | setup version | v3.0.0 | v3.0.0 |
+| provider |   required, service provider  |   string   | - |
+| account_id |   account ID  |   string   | - |
+| access_key_id  | optical account AK |  string    | - |
+| access_key_secret  | optical account SK |   string   | - |
+| secret_access_key  | optical account SK |   string   | - |
+| secret_id  | optical account AK |   string   | - |
+| secret_key  | optical account SK |   string   | - |
+| access  | access alias |  string  | default |
+| version | serverless-devs version |  3.0.0  | 3.0.0 |
+
+
+密钥相关说明详见 [Serverless-devs 文档](https://docs.serverless-devs.com/serverless-devs/default_provider_config#%E9%98%BF%E9%87%8C%E4%BA%91%E5%AF%86%E9%92%A5%E8%8E%B7%E5%8F%96)。
+
+
+## Provider's Access Configs
 
-More details about access config to [Serverless-devs docs](https://docs.serverless-devs.com/serverless-devs/default_provider_config#%E9%98%BF%E9%87%8C%E4%BA%91%E5%AF%86%E9%92%A5%E8%8E%B7%E5%8F%96).
+| Provider | Required |
+| --- | --- |
+| alibaba |    AccountID, AccessKeyID, AccessKeySecret |
+| aws |        AccessKeyID, SecretAccessKey|
+| baidu |      AccessKeyID, SecretAccessKey|
+| huawei |     AccessKeyID, SecretAccessKey|
+| azure |      KeyVaultName, TenantID, ClientID, ClientSecret|
+| tencent |    AccountID, SecretID, SecretKey|
+| google |     PrivateKeyData |