From 0eea128bc9a6986ff38e3bea89f22c4d55cd58f6 Mon Sep 17 00:00:00 2001 From: qbhfh <2682147541@qq.com> Date: Tue, 19 Oct 2021 14:34:10 +0800 Subject: [PATCH] =?UTF-8?q?fix:=20=E6=9B=B4=E6=AD=A3=E4=BA=86BOOL=E3=80=81?= =?UTF-8?q?=E5=91=BD=E5=90=8D=E7=A9=BA=E9=97=B4=E7=AD=89=E9=94=99=E8=AF=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- guide/custom-node.md | 34 +++++++++++++++++----------------- guide/secrets.md | 20 +++++++++----------- 2 files changed, 26 insertions(+), 28 deletions(-) diff --git a/guide/custom-node.md b/guide/custom-node.md index 0732369..3150ce7 100644 --- a/guide/custom-node.md +++ b/guide/custom-node.md @@ -39,22 +39,22 @@ 节点定义版本 dsl 说明： -| 关键字 | 说明 | -| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ref | 归属人或归属组织的唯一标识/节点定义在归属内的唯一标识，必填，如：jianmu/hub_publish。若为官方节点定义，则可省略归属人或归属组织的唯一标识，如：hub_publish | -| version | 节点定义的版本，必填 | -| resultFile | 输出参数转换成 json 的文件路径，若定义了输出参数 outputParameters，则必填 | -| inputParameters | 输入参数列表 | -| inputParameters.ref | 参数唯一标识，会在容器内转译成'JIANMU\_'开头并大写的环境变量。如：hub_url 在容器内可通过 JIANMU_HUB_URL 环境变量调用，必填 | -| inputParameters.name | 参数名称，必填 | -| inputParameters.type | 参数类型，支持 STRING、SECRET、NUMBER、BOOLEAN 等类型，必填。STRING/NUMBER/BOOLEAN: 若参数类型为 STRING/NUMBER/BOOLEAN，可直接填写值或引用其他变量(事件、全局、其他任务的输出等参数)。SECRET: 若参数类型为 SECRET，需要调用平台密钥，具体用法详见密钥管理章节 | -| inputParameters.value | 参数默认值，若执行该节点定义时，没有指定参数值，将会使用此默认值，必填 | -| inputParameters.description | 参数描述，选填 | -| outputParameters | 输出参数，需要在"resultFile"指定的文件内填写对应的 json 数据，key 为输出参数的唯一标识（ref）值，格式同输入参数 | -| spec | 镜像相关信息，节点定义类型为 docker 时，必填 | -| spec.image | 指定该节点定义使用的容器镜像，执行时，平台将会从 dockerhub 拉取指定镜像，必填 | -| spec.cmd | list 格式，指定容器运行时的 command 内容，选填 | -| spec.entrypoint | list 格式，指定容器运行时的 entrypoint 内容，选填 | +| 关键字 | 说明 | +| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ref | 归属人或归属组织的唯一标识/节点定义在归属内的唯一标识，必填，如：jianmu/hub_publish。若为官方节点定义，则可省略归属人或归属组织的唯一标识，如：hub_publish | +| version | 节点定义的版本，必填 | +| resultFile | 输出参数转换成 json 的文件路径，若定义了输出参数 outputParameters，则必填 | +| inputParameters | 输入参数列表 | +| inputParameters.ref | 参数唯一标识，会在容器内转译成'JIANMU\_'开头并大写的环境变量。如：hub_url 在容器内可通过 JIANMU_HUB_URL 环境变量调用，必填 | +| inputParameters.name | 参数名称，必填 | +| inputParameters.type | 参数类型，支持 STRING、SECRET、NUMBER、BOOL 等类型，必填。STRING/NUMBER/BOOL: 若参数类型为 STRING/NUMBER/BOOL，可直接填写值或引用其他变量(事件、全局、其他任务的输出等参数)。SECRET: 若参数类型为 SECRET，需要调用平台密钥，具体用法详见密钥管理章节 | +| inputParameters.value | 参数默认值，若执行该节点定义时，没有指定参数值，将会使用此默认值，必填 | +| inputParameters.description | 参数描述，选填 | +| outputParameters | 输出参数，需要在"resultFile"指定的文件路径内填写对应的 json 数据，key 为输出参数的唯一标识（ref）值，格式同输入参数 | +| spec | 镜像相关信息，节点定义类型为 docker 时，必填 | +| spec.image | 指定该节点定义使用的容器镜像，执行时，平台将会从 dockerhub 拉取指定镜像，必填 | +| spec.cmd | list 格式，指定容器运行时的 command 内容，选填 | +| spec.entrypoint | list 格式，指定容器运行时的 entrypoint 内容，选填 | 节点定义示例: @@ -117,7 +117,7 @@ spec: 1. 节点输出参数：[变量](vars.md) 2. 调用平台密钥：[密钥管理](secrets.md) -3. spe 的其他非必填参数：[spec 参数](https://gitee.com/jianmu-dev/jianmu-ci-server/blob/master/embedded-worker/src/main/java/dev/jianmu/embedded/worker/aggregate/spec/ContainerSpec.java) +3. spec 的其他非必填参数：[spec 参数](https://gitee.com/jianmu-dev/jianmu-ci-server/blob/master/embedded-worker/src/main/java/dev/jianmu/embedded/worker/aggregate/spec/ContainerSpec.java) #### 2.2. 通过节点库中的`hub_publish`节点创建流程或管道推送该节点定义版本至节点库中 diff --git a/guide/secrets.md b/guide/secrets.md index 5b2ce11..2592983 100644 --- a/guide/secrets.md +++ b/guide/secrets.md @@ -8,7 +8,6 @@ 点击“新增命名空间”框，填写命名空间名称后，点击确定，即可创建命名空间。 - ### 新增密钥 创建命名空间或，点击对应命名空间标签，进入命名空间 @@ -22,35 +21,34 @@ #### 流程中使用 密钥可在流程定义中作为节点参数使用，例如： + ``` param: username: ((namespace.username)) password: ((namespace.password)) - + ``` #### 导入项目时使用 -平台导入项目时，若访问的git项目需要认证，则需要在密钥管理中创建对应命名空间，保存用户名和密码 +平台导入项目时，若访问的 git 项目需要认证，则需要在密钥管理中创建对应命名空间，保存用户名和密码 例： -1. 创建gitlab认证密钥 - 1. 创建命令空间：gitlab - 2. 新增密钥：username：admin - 3. 新增密钥：password：123456 +1. 创建 gitlab 认证密钥 -2. 在导入项目时，选择认证，并在用户名中选择gitlab命名空间的username，密码选择password（注意：密码和用户名需要在同一命名空间内） + 1. 创建命名空间：gitlab + 2. 新增密钥：username：admin + 3. 新增密钥：password：123456 -![git_secret](./images/git_secret.png) +2. 在导入项目时，选择认证，并在用户名中选择 gitlab 命名空间的 username，密码选择 password（注意：密码和用户名需要在同一命名空间内） +![git_secret](./images/git_secret.png) ### 密钥删除 点击密钥标签右上角删除按钮，会弹出删除密钥提示框，点击确定后，即可删除密钥。 - ### 命名空间删除 点击命名空间标签右上角删除按钮，会弹出删除密钥提示框，点击确定后，即可删除对应命名空间，删除命名空间时，会同步删除其中所有的密钥。 - -- Gitee