commit by Serverless devs docs 12-11-2023 7:52:10

Serverless-Devs · Dec 11, 2023 · 910b3a6 · 910b3a6
1 parent 6752deb
commit 910b3a6
Show file tree

Hide file tree

Showing 5 changed files with 366 additions and 12 deletions.
diff --git a/content/zh/serverless-devs/command/config.md b/content/zh/serverless-devs/command/config.md
@@ -264,7 +264,7 @@ You can delete an account.
   Example:
     $ s config delete -a demo
 
-📖  Document: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs/zh/command/config.md
+📖  Document: https://serverless.help/t/s/config
 
 Options:
   -h, --help                      Display help for command

diff --git a/content/zh/serverless-devs/command/custom.md b/content/zh/serverless-devs/command/custom.md
@@ -1,7 +1,7 @@
 ---
 title: 自定义命令
 description: '自定义命令使用指南'
-position: 12
+position: 13
 category: '命令'
 ---
 

diff --git a/content/zh/serverless-devs/command/env.md b/content/zh/serverless-devs/command/env.md
@@ -0,0 +1,360 @@
+---
+title: Env 命令
+description: 'Env 命令'
+position: 12
+category: '命令'
+---
+
+# Env 命令
+
+`env`命令是对多环境配置进行管理的命令。
+
+- [命令解析](#命令解析)
+- [init 命令](#env-init-命令)
+  - [参数解析](#参数解析)
+  - [操作案例](#操作案例)
+- [list 命令](#env-list-命令)
+  - [操作案例](#操作案例-1)
+- [describe 命令](#env-describe-命令)
+  - [参数解析](#参数解析-1)
+  - [操作案例](#操作案例-2)
+- [destroy 命令](#env-destroy-命令)
+  - [参数解析](#参数解析-2)
+  - [操作案例](#操作案例-3)
+- [default 命令](#env-default-命令)
+  - [参数解析](#参数解析-3)
+  - [操作案例](#操作案例-4)
+
+## 命令解析
+
+通过执行`s env -h`，可以进行相关帮助信息的查看：
+
+```shell script
+Usage: s env [commands] [options]
+
+Managing multiple environments for serverless applications, such as testing, development, and production environments, is the best practice for serverless Devs for serverless environments.
+
+Supported vendors: Alibaba Cloud
+
+📖  Document: https://serverless.help/t/s/env
+
+Options:
+  -h, --help                      Display help for command
+
+Commands
+  init         🆕 Initialize a new environment
+  list         🔣 View the list of existing environments  
+  describe     ℹ️ Describe environmental information
+  destroy      ↩️ Delete specified environment
+  default      🔤 Set default environment
+  up           🆙 Deploy designated environmental infrastructure
+```
+
+在该命令中，包括了六个子命令
+
+- [init：初始化一个环境](#env-init-命令)
+- [list：查看当前项目的环境列表](#env-list-命令)
+- [describe：查看特定环境的信息](#env-describe-命令)
+- [destroy：删除指定环境](#env-destroy-命令)
+- [default：设置或查看默认环境](#env-default-命令)
+- [up：部署指定环境的资源](#env-up-命令)
+
+## env init 命令
+
+通过该命令，可以进行环境的初始化。
+
+执行`s env init -h`命令，可以看到帮助文档：
+
+```shell script
+Usage: s env init [options]
+
+Initialize env.
+
+    Example:
+        $ s env init --name test --project demo --description 'This is a test environment' --type testing
+
+📖  Document: https://serverless.help/t/s/env
+
+Options:
+  Options:
+  --project <project>                  Specify the project of the environment
+  -n, --name <name>                    Env name
+  --description <description>          Specify the description of the environment
+  --type <type>                        Specify the type of the environment, which must be one of testing, staging, and production. The default is testing (choices: "testing", "staging",
+                                       "production")
+  --overlays <jsonString>              Declare the differentiated configuration used in the environment, which is used to overwrite s.yaml during deployment
+  --infra-stack-name <infraStackName>  Specify the infra stack name
+  -h, --help                           Display help for command
+```
+
+### 参数解析
+
+| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
+|-----|-----|-----|-----|
+| project | - | 选填 | 指定环境所属的项目 |
+| name | n | 选填 | 环境名称 |
+| description | - | 选填 | 环境描述 |
+| type | - | 选填 | 环境类型，可选值为testing、staging、production |
+| overlays | - | 选填 | 环境的不同化配置，会覆盖 s.yaml 文件中相应的配置项 |
+| infra-stack-name | - | 选填 | 环境的基础资源栈名称 |
+
+### 操作案例
+
+初始化环境有两种方式：
+
+- 不带任何参数，使用交互式模式进行环境的初始化
+- 使用命令行模式进行环境的初始化
+
+#### 交互式模式
+
+只执行`s env init`，可进入交互式模式进行环境的初始化：
+
+```shell script
+$ s env init
+? Please specify the manifest file of the environment: env.yaml
+? Please specify the project to which the environment belongs: framework
+? Please input your environment name: dev
+? Please input a description of the environment: 
+? Please specify the type of environment: testing
+? Please input the configuration of the service to be overridden by the environment(must be json string): 
+? Please select an access: alibaba-access
+? Do you want to apply InfraStack now? Yes
+? Please select a region to deploy the environment. cn-hangzhou
+? Please select the role name acs:ram::1086969039492387:role/aliyunfcserverlessdevsrole
+ InfraStack framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea is waiting for ready, 10 seconds elapsed
+ InfraStack framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea is waiting for ready, 20 seconds elapsed
+ InfraStack framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea has been successfully implemented.
+Environment init successfully
+```
+
+此时会在当前目录下生成一个`env.yaml`文件，该文件是多环境的配置文件，其内容如下：
+
+```yaml
+project: framework
+environments:
+  - access: alibaba-access
+    name: dev
+    description: ''
+    type: testing
+    infraStack:
+      name: framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea
+      region: cn-hangzhou
+      role: acs:ram::1086969039492387:role/aliyunfcserverlessdevsrole
+      description: Using Serverless Devs to deploy the infrastructure of project:framework
+    overlays: null
+```
+
+#### 命令行模式
+
+当带有`-n`，`--project`等参数时，可直接根据参数进行初始化。例如：
+
+```shell
+$ s env init -n dev2
+Environment init successfully
+```
+
+此时再看`env.yaml`，可以看到`environments`下多了一个名为`dev2`的环境：
+
+```yaml
+project: framework
+environments:
+  ...
+  - access: default
+    name: dev2
+  ...
+```
+
+## env list 命令
+
+通过该命令，可以查看当前项目的环境列表。
+
+执行`s env list -h`命令，可以看到帮助文档：
+
+```shell script
+Usage: s env list [options]
+
+Get env list.
+
+Supported vendors: Alibaba Cloud
+
+    Example:
+        $ s env list
+
+📖  Document: https://serverless.help/t/s/env
+
+Options:
+  -h, --help                      Display help for command
+```
+
+### 操作案例
+
+执行`s env list`命令，可以看到当前项目的环境列表：
+
+```shell script
+$ s env list
+- 
+  access:      alibaba-access
+  name:        dev
+  description: 
+  type:        testing
+  infraStack: 
+    name:        framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea
+    region:      cn-hangzhou
+    role:        acs:ram::1086969039492387:role/aliyunfcserverlessdevsrole
+    description: Using Serverless Devs to deploy the infrastructure of project:framework
+  overlays:    null
+- 
+  access: default
+  name:   dev2
+```
+
+## env describe 命令
+
+通过该命令，可以查看特定环境的信息。
+
+执行`s env describe -h`命令，可以看到帮助文档：
+
+```shell script
+Usage: s env describe [options]
+
+Describe specified env.
+
+Supported vendors: Alibaba Cloud
+
+    Example:
+        $ s env describe --name test-env
+
+📖  Document: https://serverless.help/t/s/env
+
+Options:
+  -n, --name <name>               Env name
+  -h, --help                      Display help for command
+```
+
+### 参数解析
+
+| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
+|-----|-----|-----|-----|
+| name | n | 必填 | 环境名称 |
+
+### 操作案例
+
+如果想要查看某个环境的详细信息，可以通过`s env describe --name <name>`进行查看。例如：
+
+```shell
+$ s env describe --name dev
+access:      alibaba-access
+name:        dev
+description: 
+type:        testing
+infraStack: 
+  name:        framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea
+  region:      cn-hangzhou
+  role:        acs:ram::1086969039492387:role/aliyunfcserverlessdevsrole
+  description: Using Serverless Devs to deploy the infrastructure of project:framework
+overlays:    null
+```
+
+## env destroy 命令
+
+通过该命令，可以删除某个环境。
+
+执行`s env destroy -h`命令，可以看到帮助文档：
+
+```shell
+Usage: s env destroy [options]
+
+Delete specified env.
+
+Supported vendors: Alibaba Cloud
+
+    Example:
+        $ s env destroy --name test-env
+
+📖  Document: https://serverless.help/t/s/env
+
+Options:
+  -n, --name <name>               Env name
+  -h, --help                      Display help for command
+```
+
+### 参数解析
+
+| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
+|-----|-----|-----|-----|
+| name | n | 必填 | 环境名称 |
+
+### 操作案例
+
+通过`s env destroy --name <name>`可以删除特定环境。例如：
+
+```shell
+$ s env destroy -n dev
+ InfraStack framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea is waiting to be removed, 10 seconds elapsed
+ InfraStack framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea is waiting to be removed, 20 seconds elapsed
+ InfraStack framework-dev-118e98622d6d90ebb9f083d8a37620080175457474e95b3ea has been successfully implemented.
+The environment dev was destroyed successfully
+```
+
+若环境不存在，会提示：
+
+```shell script
+$ s env destroy -n dev
+
+Error Message:
+The environment dev was not found
+```
+
+## env default 命令
+
+通过该命令，可以设置或查看默认环境。
+
+执行`s env default -h`命令，可以看到帮助文档：
+
+```shell
+Usage: s env default [options]
+
+Set or check default environment.
+
+Supported vendors: Alibaba Cloud
+
+    Example:
+        $ s env default -n default
+
+📖  Document: https://serverless.help/t/s/env
+
+Options:
+  -n, --name <name>               Env name
+  -h, --help                      Displsay help for command
+```
+
+### 参数解析
+
+| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
+|-----|-----|-----|-----|
+| name | n | 选填 | 环境名称 |
+
+### 操作案例
+
+通过`s env default --name <name>`可以设置默认环境。例如：
+
+```shell
+$ s env default --name dev
+Set default env [dev] for project [framework] successfully
+```
+
+随后，可以通过`s env default`查看当前默认环境。例如：
+
+```shell
+$ s env default
+
+👉  Current default envrironment: dev
+```
+
+若没有设置默认环境，则会提示：
+
+```shell
+$ s env default
+
+👉  No default envrironment.
+```
diff --git a/content/zh/serverless-devs/command/init.md b/content/zh/serverless-devs/command/init.md
@@ -28,10 +28,10 @@ Initialize a new project based on a template. You can initialize the application
 
 Example:
     $ s init
-    $ s init project 
-    $ s init project -d my_dir
-    $ s init project --app-name my-express
-    $ s init project --parameters '{"serviceName":"websiteService"}'
+    $ s init <project> 
+    $ s init <project> -d my_dir
+    $ s init <project> --app-name my-express
+    $ s init <project> --parameters '{"serviceName":"websiteService"}'
     $ s init git@github.com:foo/bar.git
     $ s init https://github.com/foo/bar.git