From 581671a815c9ac4558c745df5951a30837592225 Mon Sep 17 00:00:00 2001 From: CeerDecy <1748788674@qq.com> Date: Mon, 15 Jul 2024 10:43:29 +0800 Subject: [PATCH 1/6] feat: platform environment variables --- docs/2.4/manual/dop/guides/reference/env.md | 93 +++++++++++++++++++ .../next/manual/dop/guides/reference/env.md | 93 +++++++++++++++++++ docs/next/manual/dop/guides/reference/env.md | 93 +++++++++++++++++++ 3 files changed, 279 insertions(+) create mode 100644 docs/2.4/manual/dop/guides/reference/env.md create mode 100644 docs/en/next/manual/dop/guides/reference/env.md create mode 100644 docs/next/manual/dop/guides/reference/env.md diff --git a/docs/2.4/manual/dop/guides/reference/env.md b/docs/2.4/manual/dop/guides/reference/env.md new file mode 100644 index 00000000..b37f7798 --- /dev/null +++ b/docs/2.4/manual/dop/guides/reference/env.md @@ -0,0 +1,93 @@ +# 平台级环境变量 + +## 流水线环境变量 + +| 变量名称 | 说明 | 示例 | +|---------------------------------|---------------|--------------------------------| +| `PIPELINE_CRON_EXPR` | - | - | +| `PIPELINE_TYPE` | - | - | +| `PIPELINE_TRIGGER_MODE` | - | - | +| `PIPELINE_STORAGE_URL` | - | - | +| `PIPELINE_CRON_TRIGGER_TIME` | - | - | +| `PIPELINE_TIME_BEGIN_TIMESTAMP` | 流水线开始时间戳 | 1707048002 | +| `PIPELINE_TASK_LOG_ID` | 流水线Task日志ID | pipeline-task-1486922756137087 | +| `PIPELINE_TASK_NAME` | 流水线Task名称 | uc-latest-release | +| `PIPELINE_LIMITED_DISK` | 流水线最大磁盘大小（MB） | 128 | +| `PIPELINE_LIMITED_MEM` | 流水线最大内存大小（MB） | 128 | +| `PIPELINE_DEBUG_MODE` | 流水线Debug模式 | false | +| `PIPELINE_TASK_ID` | 流水线TaskID | 1486922756137087 | +| `PIPELINE_LIMITED_CPU` | 流水线最大CPU数 | 0.4 | + +## 部署中心环境变量 + +| 变量名称 | 说明 | 示例 | +|----------------------------|------------------|--------------------------------------------| +| `DICE_INTERNAL_CLIENT` | - | - | +| `DICE_PROJECT_APPLICATION` | - | - | +| `DICE_ENV` | - | - | +| `DICE_OPERATOR_ID` | - | - | +| `DICE_OPERATOR_NAME` | - | - | +| `DICE_VERSION` | erda版本 | 2.4 | +| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | +| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | +| `DICE_OPENAPI_ADDR` | openapi集群内部地址 | erda-server.default.svc.cluster.local:9529 | +| `DICE_ORG_NAME` | 组织名称 | erda-development | +| `DICE_APPLICATION_ID` | 应用ID | 8766 | +| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | +| `DICE_OPENAPI_PUBLIC_URL` | openapi外部域名地址 | https://openapi.erda.daily.terminus.io/ | +| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | +| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | +| `DICE_IS_EDGE` | 是否为边缘集群？ | true | +| `DICE_PROJECT_ID` | 项目ID | 1904 | +| `DICE_STORAGE_MOUNTPOINT` | 存储路径点 | /netdata | +| `DICE_PROTOCOL` | 协议 | https | +| `DICE_PROJECT_NAME` | 项目名称 | erda-development | +| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | +| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | +| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | +| `DICE_WORKSPACE` | 应用工作空间 | test | +| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | +| `DICE_ORG_ID` | 组织ID | 633 | +| `DICE_HTTPS_PORT` | https端口 | 443 | +| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | +| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | +| `DICE_HTTP_PORT` | http端口 | 80 | +| `DICE_USER_ID` | 用户ID | 22304 | +| `DICE_SERVICE_NAME` | service名称 | golang-check | + +## Gittar环境变量 + +| 变量名称 | 说明 | 示例 | +|------------------|-----------|----| +| `GITTAR_AUTHOR` | 作者 | - | +| `GITTAR_BRANCH` | 分支 | - | +| `GITTAR_COMMIT` | commit ID | - | +| `GITTAR_MESSAGE` | 提交信息 | - | +| `GITTAR_REPO` | 仓库地址 | - | + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/en/next/manual/dop/guides/reference/env.md b/docs/en/next/manual/dop/guides/reference/env.md new file mode 100644 index 00000000..759ff059 --- /dev/null +++ b/docs/en/next/manual/dop/guides/reference/env.md @@ -0,0 +1,93 @@ +# Platform Environment Variables + +## Pipleline Envs + +| Env Name | description | example | +|---------------------------------|--------------------------------------|--------------------------------| +| `PIPELINE_CRON_EXPR` | - | - | +| `PIPELINE_TYPE` | - | - | +| `PIPELINE_TRIGGER_MODE` | - | - | +| `PIPELINE_STORAGE_URL` | - | - | +| `PIPELINE_CRON_TRIGGER_TIME` | - | - | +| `PIPELINE_TIME_BEGIN_TIMESTAMP` | pipeline begin timestamp | 1707048002 | +| `PIPELINE_TASK_LOG_ID` | pipeline task log id | pipeline-task-1486922756137087 | +| `PIPELINE_TASK_NAME` | pipeline task name | uc-latest-release | +| `PIPELINE_LIMITED_DISK` | maximum disk size for pipeline（MB） | 128 | +| `PIPELINE_LIMITED_MEM` | maximum memory size for pipeline（MB） | 128 | +| `PIPELINE_DEBUG_MODE` | enable pipeline debug mod | false | +| `PIPELINE_TASK_ID` | pipeline task id | 1486922756137087 | +| `PIPELINE_LIMITED_CPU` | maximum number of CPUs for pipeline | 0.4 | + +## Dice Envs + +| 变量名称 | 说明 | 示例 | +|----------------------------|-------------------------------------------|--------------------------------------------| +| `DICE_INTERNAL_CLIENT` | - | - | +| `DICE_PROJECT_APPLICATION` | - | - | +| `DICE_ENV` | - | - | +| `DICE_OPERATOR_ID` | - | - | +| `DICE_OPERATOR_NAME` | - | - | +| `DICE_VERSION` | erda version | 2.4 | +| `DICE_MEM_REQUEST` | requested memory size | 256 | +| `DICE_MEM_LIMIT` | maximum memory size | 256 | +| `DICE_OPENAPI_ADDR` | service DNS name of openapi in kubernetes | erda-server.default.svc.cluster.local:9529 | +| `DICE_ORG_NAME` | organization name | erda-development | +| `DICE_APPLICATION_ID` | application ID | 8766 | +| `DICE_CPU_ORIGIN` | total of CPUs | 0.1 | +| `DICE_OPENAPI_PUBLIC_URL` | domain address for openapi | https://openapi.erda.daily.terminus.io/ | +| `DICE_CPU_REQUEST` | requested CPUs | 0.05 | +| `DICE_NAMESPACE` | kubernetes namespace | project-1904-test | +| `DICE_IS_EDGE` | whether it is an edge cluster? | true | +| `DICE_PROJECT_ID` | project Id | 1904 | +| `DICE_STORAGE_MOUNTPOINT` | storage path | /netdata | +| `DICE_PROTOCOL` | protocol | https | +| `DICE_PROJECT_NAME` | project name | erda-development | +| `DICE_MEM_ORIGIN` | maximum memory size | 128 | +| `DICE_ROOT_DOMAIN` | erda domain | daily.terminus.io | +| `DICE_APPLICATION_NAME` | application name | go-demo | +| `DICE_WORKSPACE` | workspace | test | +| `DICE_CPU_LIMIT` | maximum CPUs size | 0.1 | +| `DICE_ORG_ID` | organization ID | 633 | +| `DICE_HTTPS_PORT` | https port | 443 | +| `DICE_CLUSTER_TYPE` | cluster type | kubernetes | +| `DICE_CLUSTER_NAME` | cluster name | erda-jicheng | +| `DICE_HTTP_PORT` | http port | 80 | +| `DICE_USER_ID` | user ID | 22304 | +| `DICE_SERVICE_NAME` | service name | golang-check | + +## Gittar环境变量 + +| 变量名称 | 说明 | 示例 | +|------------------|----------------|----| +| `GITTAR_AUTHOR` | author | - | +| `GITTAR_BRANCH` | branch | - | +| `GITTAR_COMMIT` | commit ID | - | +| `GITTAR_MESSAGE` | commit message | - | +| `GITTAR_REPO` | repositories | - | + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/next/manual/dop/guides/reference/env.md b/docs/next/manual/dop/guides/reference/env.md new file mode 100644 index 00000000..b37f7798 --- /dev/null +++ b/docs/next/manual/dop/guides/reference/env.md @@ -0,0 +1,93 @@ +# 平台级环境变量 + +## 流水线环境变量 + +| 变量名称 | 说明 | 示例 | +|---------------------------------|---------------|--------------------------------| +| `PIPELINE_CRON_EXPR` | - | - | +| `PIPELINE_TYPE` | - | - | +| `PIPELINE_TRIGGER_MODE` | - | - | +| `PIPELINE_STORAGE_URL` | - | - | +| `PIPELINE_CRON_TRIGGER_TIME` | - | - | +| `PIPELINE_TIME_BEGIN_TIMESTAMP` | 流水线开始时间戳 | 1707048002 | +| `PIPELINE_TASK_LOG_ID` | 流水线Task日志ID | pipeline-task-1486922756137087 | +| `PIPELINE_TASK_NAME` | 流水线Task名称 | uc-latest-release | +| `PIPELINE_LIMITED_DISK` | 流水线最大磁盘大小（MB） | 128 | +| `PIPELINE_LIMITED_MEM` | 流水线最大内存大小（MB） | 128 | +| `PIPELINE_DEBUG_MODE` | 流水线Debug模式 | false | +| `PIPELINE_TASK_ID` | 流水线TaskID | 1486922756137087 | +| `PIPELINE_LIMITED_CPU` | 流水线最大CPU数 | 0.4 | + +## 部署中心环境变量 + +| 变量名称 | 说明 | 示例 | +|----------------------------|------------------|--------------------------------------------| +| `DICE_INTERNAL_CLIENT` | - | - | +| `DICE_PROJECT_APPLICATION` | - | - | +| `DICE_ENV` | - | - | +| `DICE_OPERATOR_ID` | - | - | +| `DICE_OPERATOR_NAME` | - | - | +| `DICE_VERSION` | erda版本 | 2.4 | +| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | +| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | +| `DICE_OPENAPI_ADDR` | openapi集群内部地址 | erda-server.default.svc.cluster.local:9529 | +| `DICE_ORG_NAME` | 组织名称 | erda-development | +| `DICE_APPLICATION_ID` | 应用ID | 8766 | +| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | +| `DICE_OPENAPI_PUBLIC_URL` | openapi外部域名地址 | https://openapi.erda.daily.terminus.io/ | +| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | +| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | +| `DICE_IS_EDGE` | 是否为边缘集群？ | true | +| `DICE_PROJECT_ID` | 项目ID | 1904 | +| `DICE_STORAGE_MOUNTPOINT` | 存储路径点 | /netdata | +| `DICE_PROTOCOL` | 协议 | https | +| `DICE_PROJECT_NAME` | 项目名称 | erda-development | +| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | +| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | +| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | +| `DICE_WORKSPACE` | 应用工作空间 | test | +| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | +| `DICE_ORG_ID` | 组织ID | 633 | +| `DICE_HTTPS_PORT` | https端口 | 443 | +| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | +| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | +| `DICE_HTTP_PORT` | http端口 | 80 | +| `DICE_USER_ID` | 用户ID | 22304 | +| `DICE_SERVICE_NAME` | service名称 | golang-check | + +## Gittar环境变量 + +| 变量名称 | 说明 | 示例 | +|------------------|-----------|----| +| `GITTAR_AUTHOR` | 作者 | - | +| `GITTAR_BRANCH` | 分支 | - | +| `GITTAR_COMMIT` | commit ID | - | +| `GITTAR_MESSAGE` | 提交信息 | - | +| `GITTAR_REPO` | 仓库地址 | - | + + + + + + + + + + + + + + + + + + + + + + + + + + + From 3b1ec416cb1b938a81bc2315a0273797304ecaee Mon Sep 17 00:00:00 2001 From: CeerDecy <1748788674@qq.com> Date: Mon, 15 Jul 2024 10:45:34 +0800 Subject: [PATCH 2/6] feat: platform environment variables --- .../en/next/manual/dop/guides/reference/env.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/en/next/manual/dop/guides/reference/env.md b/docs/en/next/manual/dop/guides/reference/env.md index 759ff059..7f8a0015 100644 --- a/docs/en/next/manual/dop/guides/reference/env.md +++ b/docs/en/next/manual/dop/guides/reference/env.md @@ -2,7 +2,7 @@ ## Pipleline Envs -| Env Name | description | example | +| Env Name | Description | Example | |---------------------------------|--------------------------------------|--------------------------------| | `PIPELINE_CRON_EXPR` | - | - | | `PIPELINE_TYPE` | - | - | @@ -20,7 +20,7 @@ ## Dice Envs -| 变量名称 | 说明 | 示例 | +| Env Name | Description | Example | |----------------------------|-------------------------------------------|--------------------------------------------| | `DICE_INTERNAL_CLIENT` | - | - | | `DICE_PROJECT_APPLICATION` | - | - | @@ -57,13 +57,13 @@ ## Gittar环境变量 -| 变量名称 | 说明 | 示例 | -|------------------|----------------|----| -| `GITTAR_AUTHOR` | author | - | -| `GITTAR_BRANCH` | branch | - | -| `GITTAR_COMMIT` | commit ID | - | -| `GITTAR_MESSAGE` | commit message | - | -| `GITTAR_REPO` | repositories | - | +| Env Name | Description | Example | +|------------------|----------------|---------| +| `GITTAR_AUTHOR` | author | - | +| `GITTAR_BRANCH` | branch | - | +| `GITTAR_COMMIT` | commit ID | - | +| `GITTAR_MESSAGE` | commit message | - | +| `GITTAR_REPO` | repositories | - | From 382f54c91d18673b61056cd666a89dbd3b11b07b Mon Sep 17 00:00:00 2001 From: CeerDecy <1748788674@qq.com> Date: Mon, 15 Jul 2024 11:03:34 +0800 Subject: [PATCH 3/6] feat: remove non-existent environment variable --- docs/2.4/manual/dop/guides/reference/env.md | 10 ---------- docs/en/next/manual/dop/guides/reference/env.md | 10 ---------- docs/next/manual/dop/guides/reference/env.md | 10 ---------- 3 files changed, 30 deletions(-) diff --git a/docs/2.4/manual/dop/guides/reference/env.md b/docs/2.4/manual/dop/guides/reference/env.md index b37f7798..e44ef325 100644 --- a/docs/2.4/manual/dop/guides/reference/env.md +++ b/docs/2.4/manual/dop/guides/reference/env.md @@ -4,11 +4,6 @@ | 变量名称 | 说明 | 示例 | |---------------------------------|---------------|--------------------------------| -| `PIPELINE_CRON_EXPR` | - | - | -| `PIPELINE_TYPE` | - | - | -| `PIPELINE_TRIGGER_MODE` | - | - | -| `PIPELINE_STORAGE_URL` | - | - | -| `PIPELINE_CRON_TRIGGER_TIME` | - | - | | `PIPELINE_TIME_BEGIN_TIMESTAMP` | 流水线开始时间戳 | 1707048002 | | `PIPELINE_TASK_LOG_ID` | 流水线Task日志ID | pipeline-task-1486922756137087 | | `PIPELINE_TASK_NAME` | 流水线Task名称 | uc-latest-release | @@ -22,11 +17,6 @@ | 变量名称 | 说明 | 示例 | |----------------------------|------------------|--------------------------------------------| -| `DICE_INTERNAL_CLIENT` | - | - | -| `DICE_PROJECT_APPLICATION` | - | - | -| `DICE_ENV` | - | - | -| `DICE_OPERATOR_ID` | - | - | -| `DICE_OPERATOR_NAME` | - | - | | `DICE_VERSION` | erda版本 | 2.4 | | `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | | `DICE_MEM_LIMIT` | 最大内存大小 | 256 | diff --git a/docs/en/next/manual/dop/guides/reference/env.md b/docs/en/next/manual/dop/guides/reference/env.md index 7f8a0015..eb692bf0 100644 --- a/docs/en/next/manual/dop/guides/reference/env.md +++ b/docs/en/next/manual/dop/guides/reference/env.md @@ -4,11 +4,6 @@ | Env Name | Description | Example | |---------------------------------|--------------------------------------|--------------------------------| -| `PIPELINE_CRON_EXPR` | - | - | -| `PIPELINE_TYPE` | - | - | -| `PIPELINE_TRIGGER_MODE` | - | - | -| `PIPELINE_STORAGE_URL` | - | - | -| `PIPELINE_CRON_TRIGGER_TIME` | - | - | | `PIPELINE_TIME_BEGIN_TIMESTAMP` | pipeline begin timestamp | 1707048002 | | `PIPELINE_TASK_LOG_ID` | pipeline task log id | pipeline-task-1486922756137087 | | `PIPELINE_TASK_NAME` | pipeline task name | uc-latest-release | @@ -22,11 +17,6 @@ | Env Name | Description | Example | |----------------------------|-------------------------------------------|--------------------------------------------| -| `DICE_INTERNAL_CLIENT` | - | - | -| `DICE_PROJECT_APPLICATION` | - | - | -| `DICE_ENV` | - | - | -| `DICE_OPERATOR_ID` | - | - | -| `DICE_OPERATOR_NAME` | - | - | | `DICE_VERSION` | erda version | 2.4 | | `DICE_MEM_REQUEST` | requested memory size | 256 | | `DICE_MEM_LIMIT` | maximum memory size | 256 | diff --git a/docs/next/manual/dop/guides/reference/env.md b/docs/next/manual/dop/guides/reference/env.md index b37f7798..e44ef325 100644 --- a/docs/next/manual/dop/guides/reference/env.md +++ b/docs/next/manual/dop/guides/reference/env.md @@ -4,11 +4,6 @@ | 变量名称 | 说明 | 示例 | |---------------------------------|---------------|--------------------------------| -| `PIPELINE_CRON_EXPR` | - | - | -| `PIPELINE_TYPE` | - | - | -| `PIPELINE_TRIGGER_MODE` | - | - | -| `PIPELINE_STORAGE_URL` | - | - | -| `PIPELINE_CRON_TRIGGER_TIME` | - | - | | `PIPELINE_TIME_BEGIN_TIMESTAMP` | 流水线开始时间戳 | 1707048002 | | `PIPELINE_TASK_LOG_ID` | 流水线Task日志ID | pipeline-task-1486922756137087 | | `PIPELINE_TASK_NAME` | 流水线Task名称 | uc-latest-release | @@ -22,11 +17,6 @@ | 变量名称 | 说明 | 示例 | |----------------------------|------------------|--------------------------------------------| -| `DICE_INTERNAL_CLIENT` | - | - | -| `DICE_PROJECT_APPLICATION` | - | - | -| `DICE_ENV` | - | - | -| `DICE_OPERATOR_ID` | - | - | -| `DICE_OPERATOR_NAME` | - | - | | `DICE_VERSION` | erda版本 | 2.4 | | `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | | `DICE_MEM_LIMIT` | 最大内存大小 | 256 | From 3c1e01d9838bc396a3df62f181cf80731c072cc1 Mon Sep 17 00:00:00 2001 From: CeerDecy <1748788674@qq.com> Date: Mon, 15 Jul 2024 11:23:42 +0800 Subject: [PATCH 4/6] feat: gittar env --- docs/2.4/manual/dop/guides/reference/env.md | 72 ++++++++++----------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/2.4/manual/dop/guides/reference/env.md b/docs/2.4/manual/dop/guides/reference/env.md index e44ef325..20e316f2 100644 --- a/docs/2.4/manual/dop/guides/reference/env.md +++ b/docs/2.4/manual/dop/guides/reference/env.md @@ -15,45 +15,45 @@ ## 部署中心环境变量 -| 变量名称 | 说明 | 示例 | -|----------------------------|------------------|--------------------------------------------| -| `DICE_VERSION` | erda版本 | 2.4 | -| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | -| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | -| `DICE_OPENAPI_ADDR` | openapi集群内部地址 | erda-server.default.svc.cluster.local:9529 | -| `DICE_ORG_NAME` | 组织名称 | erda-development | -| `DICE_APPLICATION_ID` | 应用ID | 8766 | -| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | -| `DICE_OPENAPI_PUBLIC_URL` | openapi外部域名地址 | https://openapi.erda.daily.terminus.io/ | -| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | -| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | -| `DICE_IS_EDGE` | 是否为边缘集群？ | true | -| `DICE_PROJECT_ID` | 项目ID | 1904 | -| `DICE_STORAGE_MOUNTPOINT` | 存储路径点 | /netdata | -| `DICE_PROTOCOL` | 协议 | https | -| `DICE_PROJECT_NAME` | 项目名称 | erda-development | -| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | -| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | -| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | -| `DICE_WORKSPACE` | 应用工作空间 | test | -| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | -| `DICE_ORG_ID` | 组织ID | 633 | -| `DICE_HTTPS_PORT` | https端口 | 443 | -| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | -| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | -| `DICE_HTTP_PORT` | http端口 | 80 | -| `DICE_USER_ID` | 用户ID | 22304 | -| `DICE_SERVICE_NAME` | service名称 | golang-check | +| 变量名称 | 说明 | 示例 | +|---------------------------|------------------|--------------------------------------------| +| `DICE_VERSION` | erda版本 | 2.4 | +| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | +| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | +| `DICE_OPENAPI_ADDR` | openapi集群内部地址 | erda-server.default.svc.cluster.local:9529 | +| `DICE_ORG_NAME` | 组织名称 | erda-development | +| `DICE_APPLICATION_ID` | 应用ID | 8766 | +| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | +| `DICE_OPENAPI_PUBLIC_URL` | openapi外部域名地址 | https://openapi.erda.daily.terminus.io/ | +| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | +| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | +| `DICE_IS_EDGE` | 是否为边缘集群？ | true | +| `DICE_PROJECT_ID` | 项目ID | 1904 | +| `DICE_STORAGE_MOUNTPOINT` | 存储路径点 | /netdata | +| `DICE_PROTOCOL` | 协议 | https | +| `DICE_PROJECT_NAME` | 项目名称 | erda-development | +| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | +| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | +| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | +| `DICE_WORKSPACE` | 应用工作空间 | test | +| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | +| `DICE_ORG_ID` | 组织ID | 633 | +| `DICE_HTTPS_PORT` | https端口 | 443 | +| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | +| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | +| `DICE_HTTP_PORT` | http端口 | 80 | +| `DICE_USER_ID` | 用户ID | 22304 | +| `DICE_SERVICE_NAME` | service名称 | golang-check | ## Gittar环境变量 -| 变量名称 | 说明 | 示例 | -|------------------|-----------|----| -| `GITTAR_AUTHOR` | 作者 | - | -| `GITTAR_BRANCH` | 分支 | - | -| `GITTAR_COMMIT` | commit ID | - | -| `GITTAR_MESSAGE` | 提交信息 | - | -| `GITTAR_REPO` | 仓库地址 | - | +| 变量名称 | 说明 | 示例 | +|------------------|-----------|-----------------------------------------------------------------| +| `GITTAR_AUTHOR` | 作者 | Demo | +| `GITTAR_BRANCH` | 分支 | feature/1.0 | +| `GITTAR_COMMIT` | commit ID | 3ad7a17163ee8f1a431389bea75a2738e710a4f0 | +| `GITTAR_MESSAGE` | 提交信息 | feat: update pipeline | +| `GITTAR_REPO` | 仓库地址 | http://gittar.namespace.svc.cluster.local/demo-project/demo-app | From ef9eecac7c32a8e9bc3281054511f6a0aa57605b Mon Sep 17 00:00:00 2001 From: CeerDecy <1748788674@qq.com> Date: Mon, 15 Jul 2024 16:29:59 +0800 Subject: [PATCH 5/6] faet: update docs --- docs/2.4/manual/dop/guides/reference/env.md | 140 ++++++++--------- .../next/manual/dop/guides/reference/env.md | 148 ++++++++---------- docs/next/manual/dop/guides/reference/env.md | 140 ++++++++--------- 3 files changed, 193 insertions(+), 235 deletions(-) diff --git a/docs/2.4/manual/dop/guides/reference/env.md b/docs/2.4/manual/dop/guides/reference/env.md index 20e316f2..4588980e 100644 --- a/docs/2.4/manual/dop/guides/reference/env.md +++ b/docs/2.4/manual/dop/guides/reference/env.md @@ -1,83 +1,69 @@ # 平台级环境变量 -## 流水线环境变量 - -| 变量名称 | 说明 | 示例 | -|---------------------------------|---------------|--------------------------------| -| `PIPELINE_TIME_BEGIN_TIMESTAMP` | 流水线开始时间戳 | 1707048002 | -| `PIPELINE_TASK_LOG_ID` | 流水线Task日志ID | pipeline-task-1486922756137087 | -| `PIPELINE_TASK_NAME` | 流水线Task名称 | uc-latest-release | -| `PIPELINE_LIMITED_DISK` | 流水线最大磁盘大小（MB） | 128 | -| `PIPELINE_LIMITED_MEM` | 流水线最大内存大小（MB） | 128 | -| `PIPELINE_DEBUG_MODE` | 流水线Debug模式 | false | -| `PIPELINE_TASK_ID` | 流水线TaskID | 1486922756137087 | -| `PIPELINE_LIMITED_CPU` | 流水线最大CPU数 | 0.4 | - -## 部署中心环境变量 - -| 变量名称 | 说明 | 示例 | -|---------------------------|------------------|--------------------------------------------| -| `DICE_VERSION` | erda版本 | 2.4 | -| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | -| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | -| `DICE_OPENAPI_ADDR` | openapi集群内部地址 | erda-server.default.svc.cluster.local:9529 | -| `DICE_ORG_NAME` | 组织名称 | erda-development | -| `DICE_APPLICATION_ID` | 应用ID | 8766 | -| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | -| `DICE_OPENAPI_PUBLIC_URL` | openapi外部域名地址 | https://openapi.erda.daily.terminus.io/ | -| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | -| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | -| `DICE_IS_EDGE` | 是否为边缘集群？ | true | -| `DICE_PROJECT_ID` | 项目ID | 1904 | -| `DICE_STORAGE_MOUNTPOINT` | 存储路径点 | /netdata | -| `DICE_PROTOCOL` | 协议 | https | -| `DICE_PROJECT_NAME` | 项目名称 | erda-development | -| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | -| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | -| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | -| `DICE_WORKSPACE` | 应用工作空间 | test | -| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | -| `DICE_ORG_ID` | 组织ID | 633 | -| `DICE_HTTPS_PORT` | https端口 | 443 | -| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | -| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | -| `DICE_HTTP_PORT` | http端口 | 80 | -| `DICE_USER_ID` | 用户ID | 22304 | -| `DICE_SERVICE_NAME` | service名称 | golang-check | - -## Gittar环境变量 - -| 变量名称 | 说明 | 示例 | -|------------------|-----------|-----------------------------------------------------------------| -| `GITTAR_AUTHOR` | 作者 | Demo | -| `GITTAR_BRANCH` | 分支 | feature/1.0 | -| `GITTAR_COMMIT` | commit ID | 3ad7a17163ee8f1a431389bea75a2738e710a4f0 | -| `GITTAR_MESSAGE` | 提交信息 | feat: update pipeline | -| `GITTAR_REPO` | 仓库地址 | http://gittar.namespace.svc.cluster.local/demo-project/demo-app | - - - - - - - - - - - - - - - - - - - - - - - +## 公共环境变量 +> 以下环境变量，流水线和应用运行时都会存在 +| 变量名称 | 说明 | 示例 | +|---------------------|------------------|-------------------| +| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | +| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | +| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | +| `DICE_PROTOCOL` | 协议 | https | +## 流水线环境变量 +> 以下环境变量，存在于流水线Action中 + +| 变量名称 | 说明 | 示例 | +|---------------------------------|---------------|-----------------------------------------------------------------| +| `GITTAR_AUTHOR` | 作者 | Demo | +| `GITTAR_BRANCH` | 分支 | feature/1.0 | +| `GITTAR_COMMIT` | commit ID | 3ad7a17163ee8f1a431389bea75a2738e710a4f0 | +| `GITTAR_MESSAGE` | 提交信息 | feat: update pipeline | +| `GITTAR_REPO` | 仓库地址 | http://gittar.namespace.svc.cluster.local/demo-project/demo-app | +| `PIPELINE_TIME_BEGIN_TIMESTAMP` | 流水线开始时间戳 | 1707048002 | +| `PIPELINE_TASK_LOG_ID` | 流水线Task日志ID | pipeline-task-1486922756137087 | +| `PIPELINE_TASK_NAME` | 流水线Task名称 | uc-latest-release | +| `PIPELINE_LIMITED_DISK` | 流水线最大磁盘大小（MB） | 128 | +| `PIPELINE_LIMITED_MEM` | 流水线最大内存大小（MB） | 128 | +| `PIPELINE_DEBUG_MODE` | 流水线Debug模式 | false | +| `PIPELINE_TASK_ID` | 流水线TaskID | 1486922756137087 | +| `PIPELINE_LIMITED_CPU` | 流水线最大CPU数 | 0.4 | +| `DICE_OPENAPI_ADDR` | openapi集群内部地址 | erda-server.default.svc.cluster.local:9529 | +| `DICE_OPENAPI_PUBLIC_URL` | openapi外部域名地址 | https://openapi.erda.daily.terminus.io/ | +| `DICE_VERSION` | erda版本 | 2.4 | +| `DICE_HTTPS_PORT` | https端口 | 443 | +| `DICE_STORAGE_MOUNTPOINT` | 存储路径点 | /netdata | + +## 应用运行时环境变量 + +> 以下环境变量，存在于应用运行时 + +| 变量名称 | 说明 | 示例 | +|-------------------------|------------------|---------------------------------------| +| `POD_IP` | Pod IP | 10.16.3.194 | +| `SELF_PORT` | Pod端口 | 25565 | +| `SELF_PORT(n)` | Pod开放的端口(n >= 0) | 25565 | +| `SELF_HOST` | Pod集群内部地址 | demo.demo-namespace.svc.cluster.local | +| `TERMINUS_TA_ENABLE` | 开启前端Ta监控 | true | +| `TERMINUS_AGENT_ENABLE` | 是否开启agent代理 | true | +| `DICE_RUNTIME` | Runtime ID | 19635 | +| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | +| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | +| `DICE_ORG_NAME` | 组织名称 | erda-development | +| `DICE_APPLICATION_ID` | 应用ID | 8766 | +| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | +| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | +| `DICE_IS_EDGE` | 是否为边缘集群？ | true | +| `DICE_PROJECT_ID` | 项目ID | 1904 | +| `DICE_PROJECT_NAME` | 项目名称 | erda-development | +| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | +| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | +| `DICE_WORKSPACE` | 应用工作空间 | test | +| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | +| `DICE_ORG_ID` | 组织ID | 633 | +| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | +| `DICE_HTTP_PORT` | http端口 | 80 | +| `DICE_USER_ID` | 用户ID | 22304 | +| `DICE_SERVICE_NAME` | service名称 | golang-check | \ No newline at end of file diff --git a/docs/en/next/manual/dop/guides/reference/env.md b/docs/en/next/manual/dop/guides/reference/env.md index eb692bf0..9469e544 100644 --- a/docs/en/next/manual/dop/guides/reference/env.md +++ b/docs/en/next/manual/dop/guides/reference/env.md @@ -1,83 +1,69 @@ # Platform Environment Variables -## Pipleline Envs - -| Env Name | Description | Example | -|---------------------------------|--------------------------------------|--------------------------------| -| `PIPELINE_TIME_BEGIN_TIMESTAMP` | pipeline begin timestamp | 1707048002 | -| `PIPELINE_TASK_LOG_ID` | pipeline task log id | pipeline-task-1486922756137087 | -| `PIPELINE_TASK_NAME` | pipeline task name | uc-latest-release | -| `PIPELINE_LIMITED_DISK` | maximum disk size for pipeline（MB） | 128 | -| `PIPELINE_LIMITED_MEM` | maximum memory size for pipeline（MB） | 128 | -| `PIPELINE_DEBUG_MODE` | enable pipeline debug mod | false | -| `PIPELINE_TASK_ID` | pipeline task id | 1486922756137087 | -| `PIPELINE_LIMITED_CPU` | maximum number of CPUs for pipeline | 0.4 | - -## Dice Envs - -| Env Name | Description | Example | -|----------------------------|-------------------------------------------|--------------------------------------------| -| `DICE_VERSION` | erda version | 2.4 | -| `DICE_MEM_REQUEST` | requested memory size | 256 | -| `DICE_MEM_LIMIT` | maximum memory size | 256 | -| `DICE_OPENAPI_ADDR` | service DNS name of openapi in kubernetes | erda-server.default.svc.cluster.local:9529 | -| `DICE_ORG_NAME` | organization name | erda-development | -| `DICE_APPLICATION_ID` | application ID | 8766 | -| `DICE_CPU_ORIGIN` | total of CPUs | 0.1 | -| `DICE_OPENAPI_PUBLIC_URL` | domain address for openapi | https://openapi.erda.daily.terminus.io/ | -| `DICE_CPU_REQUEST` | requested CPUs | 0.05 | -| `DICE_NAMESPACE` | kubernetes namespace | project-1904-test | -| `DICE_IS_EDGE` | whether it is an edge cluster? | true | -| `DICE_PROJECT_ID` | project Id | 1904 | -| `DICE_STORAGE_MOUNTPOINT` | storage path | /netdata | -| `DICE_PROTOCOL` | protocol | https | -| `DICE_PROJECT_NAME` | project name | erda-development | -| `DICE_MEM_ORIGIN` | maximum memory size | 128 | -| `DICE_ROOT_DOMAIN` | erda domain | daily.terminus.io | -| `DICE_APPLICATION_NAME` | application name | go-demo | -| `DICE_WORKSPACE` | workspace | test | -| `DICE_CPU_LIMIT` | maximum CPUs size | 0.1 | -| `DICE_ORG_ID` | organization ID | 633 | -| `DICE_HTTPS_PORT` | https port | 443 | -| `DICE_CLUSTER_TYPE` | cluster type | kubernetes | -| `DICE_CLUSTER_NAME` | cluster name | erda-jicheng | -| `DICE_HTTP_PORT` | http port | 80 | -| `DICE_USER_ID` | user ID | 22304 | -| `DICE_SERVICE_NAME` | service name | golang-check | - -## Gittar环境变量 - -| Env Name | Description | Example | -|------------------|----------------|---------| -| `GITTAR_AUTHOR` | author | - | -| `GITTAR_BRANCH` | branch | - | -| `GITTAR_COMMIT` | commit ID | - | -| `GITTAR_MESSAGE` | commit message | - | -| `GITTAR_REPO` | repositories | - | - - - - - - - - - - - - - - - - - - - - - - - - - - - +## Common Environment Variables + +> The following environment variables are present during both pipeline execution and application runtime. + +| Variable Name | Description | Example | +|---------------------|--------------------------------------|-------------------| +| `DICE_NAMESPACE` | Namespace of the current application | project-1904-test | +| `DICE_ROOT_DOMAIN` | Erda central domain | daily.terminus.io | +| `DICE_CLUSTER_NAME` | Cluster name | erda-jicheng | +| `DICE_PROTOCOL` | Protocol | https | + +## Pipeline Environment Variables + +> The following environment variables are present in the pipeline Action. + +| Variable Name | Description | Example | +|---------------------------------|-----------------------------------------|-----------------------------------------------------------------| +| `GITTAR_AUTHOR` | Author | Demo | +| `GITTAR_BRANCH` | Branch | feature/1.0 | +| `GITTAR_COMMIT` | Commit ID | 3ad7a17163ee8f1a431389bea75a2738e710a4f0 | +| `GITTAR_MESSAGE` | Commit message | feat: update pipeline | +| `GITTAR_REPO` | Repository address | http://gittar.namespace.svc.cluster.local/demo-project/demo-app | +| `PIPELINE_TIME_BEGIN_TIMESTAMP` | Pipeline start timestamp | 1707048002 | +| `PIPELINE_TASK_LOG_ID` | Pipeline task log ID | pipeline-task-1486922756137087 | +| `PIPELINE_TASK_NAME` | Pipeline task name | uc-latest-release | +| `PIPELINE_LIMITED_DISK` | Max disk size for the pipeline (MB) | 128 | +| `PIPELINE_LIMITED_MEM` | Max memory size for the pipeline (MB) | 128 | +| `PIPELINE_DEBUG_MODE` | Pipeline debug mode | false | +| `PIPELINE_TASK_ID` | Pipeline task ID | 1486922756137087 | +| `PIPELINE_LIMITED_CPU` | Max CPU count for the pipeline | 0.4 | +| `DICE_OPENAPI_ADDR` | Internal address of the OpenAPI cluster | erda-server.default.svc.cluster.local:9529 | +| `DICE_OPENAPI_PUBLIC_URL` | External domain address of OpenAPI | https://openapi.erda.daily.terminus.io/ | +| `DICE_VERSION` | Erda version | 2.4 | +| `DICE_HTTPS_PORT` | HTTPS port | 443 | +| `DICE_STORAGE_MOUNTPOINT` | Storage mount point | /netdata | + +## Application Runtime Environment Variables + +> The following environment variables are present during application runtime. + +| Variable Name | Description | Example | +|-------------------------|-------------------------------------------|---------------------------------------| +| `POD_IP` | Pod IP | 10.16.3.194 | +| `SELF_PORT` | Pod port | 25565 | +| `SELF_PORT(n)` | Possible open ports of the Pod (n >= 0) | 25565 | +| `SELF_HOST` | Internal address of the Pod in Kubernetes | demo.demo-namespace.svc.cluster.local | +| `TERMINUS_TA_ENABLE` | Enable frontend TA monitoring | true | +| `TERMINUS_AGENT_ENABLE` | Enable agent proxy | true | +| `DICE_RUNTIME` | Runtime ID | 19635 | +| `DICE_MEM_REQUEST` | Requested memory size | 256 | +| `DICE_MEM_LIMIT` | Max memory size | 256 | +| `DICE_ORG_NAME` | Organization name | erda-development | +| `DICE_APPLICATION_ID` | Application ID | 8766 | +| `DICE_CPU_ORIGIN` | Total CPU size | 0.1 | +| `DICE_CPU_REQUEST` | Requested CPU size | 0.05 | +| `DICE_IS_EDGE` | Is it an edge cluster? | true | +| `DICE_PROJECT_ID` | Project ID | 1904 | +| `DICE_PROJECT_NAME` | Project name | erda-development | +| `DICE_MEM_ORIGIN` | Total memory size | 128 | +| `DICE_APPLICATION_NAME` | Application name | go-demo | +| `DICE_WORKSPACE` | Application workspace | test | +| `DICE_CPU_LIMIT` | Max CPU count | 0.1 | +| `DICE_ORG_ID` | Organization ID | 633 | +| `DICE_CLUSTER_TYPE` | Cluster type | kubernetes | +| `DICE_HTTP_PORT` | HTTP port | 80 | +| `DICE_USER_ID` | User ID | 22304 | +| `DICE_SERVICE_NAME` | Service name | golang-check | diff --git a/docs/next/manual/dop/guides/reference/env.md b/docs/next/manual/dop/guides/reference/env.md index e44ef325..3f911fcb 100644 --- a/docs/next/manual/dop/guides/reference/env.md +++ b/docs/next/manual/dop/guides/reference/env.md @@ -1,83 +1,69 @@ # 平台级环境变量 -## 流水线环境变量 - -| 变量名称 | 说明 | 示例 | -|---------------------------------|---------------|--------------------------------| -| `PIPELINE_TIME_BEGIN_TIMESTAMP` | 流水线开始时间戳 | 1707048002 | -| `PIPELINE_TASK_LOG_ID` | 流水线Task日志ID | pipeline-task-1486922756137087 | -| `PIPELINE_TASK_NAME` | 流水线Task名称 | uc-latest-release | -| `PIPELINE_LIMITED_DISK` | 流水线最大磁盘大小（MB） | 128 | -| `PIPELINE_LIMITED_MEM` | 流水线最大内存大小（MB） | 128 | -| `PIPELINE_DEBUG_MODE` | 流水线Debug模式 | false | -| `PIPELINE_TASK_ID` | 流水线TaskID | 1486922756137087 | -| `PIPELINE_LIMITED_CPU` | 流水线最大CPU数 | 0.4 | - -## 部署中心环境变量 - -| 变量名称 | 说明 | 示例 | -|----------------------------|------------------|--------------------------------------------| -| `DICE_VERSION` | erda版本 | 2.4 | -| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | -| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | -| `DICE_OPENAPI_ADDR` | openapi集群内部地址 | erda-server.default.svc.cluster.local:9529 | -| `DICE_ORG_NAME` | 组织名称 | erda-development | -| `DICE_APPLICATION_ID` | 应用ID | 8766 | -| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | -| `DICE_OPENAPI_PUBLIC_URL` | openapi外部域名地址 | https://openapi.erda.daily.terminus.io/ | -| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | -| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | -| `DICE_IS_EDGE` | 是否为边缘集群？ | true | -| `DICE_PROJECT_ID` | 项目ID | 1904 | -| `DICE_STORAGE_MOUNTPOINT` | 存储路径点 | /netdata | -| `DICE_PROTOCOL` | 协议 | https | -| `DICE_PROJECT_NAME` | 项目名称 | erda-development | -| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | -| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | -| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | -| `DICE_WORKSPACE` | 应用工作空间 | test | -| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | -| `DICE_ORG_ID` | 组织ID | 633 | -| `DICE_HTTPS_PORT` | https端口 | 443 | -| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | -| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | -| `DICE_HTTP_PORT` | http端口 | 80 | -| `DICE_USER_ID` | 用户ID | 22304 | -| `DICE_SERVICE_NAME` | service名称 | golang-check | - -## Gittar环境变量 - -| 变量名称 | 说明 | 示例 | -|------------------|-----------|----| -| `GITTAR_AUTHOR` | 作者 | - | -| `GITTAR_BRANCH` | 分支 | - | -| `GITTAR_COMMIT` | commit ID | - | -| `GITTAR_MESSAGE` | 提交信息 | - | -| `GITTAR_REPO` | 仓库地址 | - | - - - - - - - - - - - - - - - - - - - - - - - +## 公共环境变量 +> 以下环境变量，流水线和应用运行时都会存在 +| 变量名称 | 说明 | 示例 | +|---------------------|------------------|-------------------| +| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | +| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | +| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | +| `DICE_PROTOCOL` | 协议 | https | +## 流水线环境变量 +> 以下环境变量，存在于流水线Action中 + +| 变量名称 | 说明 | 示例 | +|---------------------------------|---------------|-----------------------------------------------------------------| +| `GITTAR_AUTHOR` | 作者 | Demo | +| `GITTAR_BRANCH` | 分支 | feature/1.0 | +| `GITTAR_COMMIT` | commit ID | 3ad7a17163ee8f1a431389bea75a2738e710a4f0 | +| `GITTAR_MESSAGE` | 提交信息 | feat: update pipeline | +| `GITTAR_REPO` | 仓库地址 | http://gittar.namespace.svc.cluster.local/demo-project/demo-app | +| `PIPELINE_TIME_BEGIN_TIMESTAMP` | 流水线开始时间戳 | 1707048002 | +| `PIPELINE_TASK_LOG_ID` | 流水线Task日志ID | pipeline-task-1486922756137087 | +| `PIPELINE_TASK_NAME` | 流水线Task名称 | uc-latest-release | +| `PIPELINE_LIMITED_DISK` | 流水线最大磁盘大小（MB） | 128 | +| `PIPELINE_LIMITED_MEM` | 流水线最大内存大小（MB） | 128 | +| `PIPELINE_DEBUG_MODE` | 流水线Debug模式 | false | +| `PIPELINE_TASK_ID` | 流水线TaskID | 1486922756137087 | +| `PIPELINE_LIMITED_CPU` | 流水线最大CPU数 | 0.4 | +| `DICE_OPENAPI_ADDR` | openapi集群内部地址 | erda-server.default.svc.cluster.local:9529 | +| `DICE_OPENAPI_PUBLIC_URL` | openapi外部域名地址 | https://openapi.erda.daily.terminus.io/ | +| `DICE_VERSION` | erda版本 | 2.4 | +| `DICE_HTTPS_PORT` | https端口 | 443 | +| `DICE_STORAGE_MOUNTPOINT` | 存储路径点 | /netdata | + +## 应用运行时环境变量 + +> 以下环境变量，存在于应用运行时 + +| 变量名称 | 说明 | 示例 | +|-------------------------|----------------|---------------------------------------| +| `POD_IP` | Pod IP | 10.16.3.194 | +| `SELF_PORT` | Pod端口 | 25565 | +| `SELF_PORT(0-n)` | Pod开放的端口可能有n多个 | 25565 | +| `SELF_HOST` | Pod集群内部地址 | demo.demo-namespace.svc.cluster.local | +| `TERMINUS_TA_ENABLE` | 开启前端Ta监控 | true | +| `TERMINUS_AGENT_ENABLE` | 是否开启agent代理 | true | +| `DICE_RUNTIME` | Runtime ID | 19635 | +| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | +| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | +| `DICE_ORG_NAME` | 组织名称 | erda-development | +| `DICE_APPLICATION_ID` | 应用ID | 8766 | +| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | +| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | +| `DICE_IS_EDGE` | 是否为边缘集群？ | true | +| `DICE_PROJECT_ID` | 项目ID | 1904 | +| `DICE_PROJECT_NAME` | 项目名称 | erda-development | +| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | +| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | +| `DICE_WORKSPACE` | 应用工作空间 | test | +| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | +| `DICE_ORG_ID` | 组织ID | 633 | +| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | +| `DICE_HTTP_PORT` | http端口 | 80 | +| `DICE_USER_ID` | 用户ID | 22304 | +| `DICE_SERVICE_NAME` | service名称 | golang-check | \ No newline at end of file From 07de444183fc0c25000d2c4f5854151542e6876c Mon Sep 17 00:00:00 2001 From: CeerDecy <1748788674@qq.com> Date: Thu, 18 Jul 2024 17:50:02 +0800 Subject: [PATCH 6/6] feat: title link to runtime and pipeline --- docs/2.4/manual/dop/guides/reference/env.md | 72 +++++++++---------- .../next/manual/dop/guides/reference/env.md | 4 +- docs/next/manual/dop/guides/reference/env.md | 72 +++++++++---------- 3 files changed, 74 insertions(+), 74 deletions(-) diff --git a/docs/2.4/manual/dop/guides/reference/env.md b/docs/2.4/manual/dop/guides/reference/env.md index 4588980e..689d66f0 100644 --- a/docs/2.4/manual/dop/guides/reference/env.md +++ b/docs/2.4/manual/dop/guides/reference/env.md @@ -2,18 +2,18 @@ ## 公共环境变量 -> 以下环境变量，流水线和应用运行时都会存在 +> 以下环境变量，[流水线](pipeline.md)和[Runtime](../../../quick-start/premise.md#服务和-runtime)都会存在 -| 变量名称 | 说明 | 示例 | -|---------------------|------------------|-------------------| -| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | -| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | -| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | -| `DICE_PROTOCOL` | 协议 | https | +| 变量名称 | 说明 | 示例 | +|---------------------|-------------------|-------------------| +| `DICE_NAMESPACE` | 当前应用所在的 Namespace | project-1904-test | +| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | +| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | +| `DICE_PROTOCOL` | 协议 | https | ## 流水线环境变量 -> 以下环境变量，存在于流水线Action中 +> 以下环境变量，存在于[流水线](pipeline.md)Action中 | 变量名称 | 说明 | 示例 | |---------------------------------|---------------|-----------------------------------------------------------------| @@ -38,32 +38,32 @@ ## 应用运行时环境变量 -> 以下环境变量，存在于应用运行时 +> 以下环境变量，存在于[Runtime](../../../quick-start/premise.md#服务和-runtime) -| 变量名称 | 说明 | 示例 | -|-------------------------|------------------|---------------------------------------| -| `POD_IP` | Pod IP | 10.16.3.194 | -| `SELF_PORT` | Pod端口 | 25565 | -| `SELF_PORT(n)` | Pod开放的端口(n >= 0) | 25565 | -| `SELF_HOST` | Pod集群内部地址 | demo.demo-namespace.svc.cluster.local | -| `TERMINUS_TA_ENABLE` | 开启前端Ta监控 | true | -| `TERMINUS_AGENT_ENABLE` | 是否开启agent代理 | true | -| `DICE_RUNTIME` | Runtime ID | 19635 | -| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | -| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | -| `DICE_ORG_NAME` | 组织名称 | erda-development | -| `DICE_APPLICATION_ID` | 应用ID | 8766 | -| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | -| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | -| `DICE_IS_EDGE` | 是否为边缘集群？ | true | -| `DICE_PROJECT_ID` | 项目ID | 1904 | -| `DICE_PROJECT_NAME` | 项目名称 | erda-development | -| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | -| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | -| `DICE_WORKSPACE` | 应用工作空间 | test | -| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | -| `DICE_ORG_ID` | 组织ID | 633 | -| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | -| `DICE_HTTP_PORT` | http端口 | 80 | -| `DICE_USER_ID` | 用户ID | 22304 | -| `DICE_SERVICE_NAME` | service名称 | golang-check | \ No newline at end of file +| 变量名称 | 说明 | 示例 | +|-------------------------|-----------------------|---------------------------------------| +| `POD_IP` | Pod IP | 10.16.3.194 | +| `SELF_PORT` | Pod端口 | 25565 | +| `SELF_PORT(n)` | Pod开放的端口(n >= 0) | 25565 | +| `SELF_HOST` | Pod集群内部地址 | demo.demo-namespace.svc.cluster.local | +| `TERMINUS_TA_ENABLE` | 开启前端Ta监控 | true | +| `TERMINUS_AGENT_ENABLE` | 是否开启JavaAgent等监控Agent | true | +| `DICE_RUNTIME` | Runtime ID | 19635 | +| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | +| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | +| `DICE_ORG_NAME` | 组织名称 | erda-development | +| `DICE_APPLICATION_ID` | 应用ID | 8766 | +| `DICE_CPU_ORIGIN` | CPU配置的原始值 | 0.1 | +| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | +| `DICE_IS_EDGE` | 是否为边缘集群 | true | +| `DICE_PROJECT_ID` | 项目ID | 1904 | +| `DICE_PROJECT_NAME` | 项目名称 | erda-development | +| `DICE_MEM_ORIGIN` | 内存配置的原始值 | 128 | +| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | +| `DICE_WORKSPACE` | 应用工作空间 | test | +| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | +| `DICE_ORG_ID` | 组织ID | 633 | +| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | +| `DICE_HTTP_PORT` | http端口 | 80 | +| `DICE_USER_ID` | 用户ID | 22304 | +| `DICE_SERVICE_NAME` | service名称 | golang-check | \ No newline at end of file diff --git a/docs/en/next/manual/dop/guides/reference/env.md b/docs/en/next/manual/dop/guides/reference/env.md index 9469e544..80d246fc 100644 --- a/docs/en/next/manual/dop/guides/reference/env.md +++ b/docs/en/next/manual/dop/guides/reference/env.md @@ -2,7 +2,7 @@ ## Common Environment Variables -> The following environment variables are present during both pipeline execution and application runtime. +> The following environment variables are present during both pipeline execution and application [runtime](../../../quick-start/premise.md#service-and-runtime). | Variable Name | Description | Example | |---------------------|--------------------------------------|-------------------| @@ -38,7 +38,7 @@ ## Application Runtime Environment Variables -> The following environment variables are present during application runtime. +> The following environment variables are present during application [runtime](../../../quick-start/premise.md#service-and-runtime).. | Variable Name | Description | Example | |-------------------------|-------------------------------------------|---------------------------------------| diff --git a/docs/next/manual/dop/guides/reference/env.md b/docs/next/manual/dop/guides/reference/env.md index 3f911fcb..689d66f0 100644 --- a/docs/next/manual/dop/guides/reference/env.md +++ b/docs/next/manual/dop/guides/reference/env.md @@ -2,18 +2,18 @@ ## 公共环境变量 -> 以下环境变量，流水线和应用运行时都会存在 +> 以下环境变量，[流水线](pipeline.md)和[Runtime](../../../quick-start/premise.md#服务和-runtime)都会存在 -| 变量名称 | 说明 | 示例 | -|---------------------|------------------|-------------------| -| `DICE_NAMESPACE` | 当前应用所在的Namespace | project-1904-test | -| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | -| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | -| `DICE_PROTOCOL` | 协议 | https | +| 变量名称 | 说明 | 示例 | +|---------------------|-------------------|-------------------| +| `DICE_NAMESPACE` | 当前应用所在的 Namespace | project-1904-test | +| `DICE_ROOT_DOMAIN` | erda中心域名 | daily.terminus.io | +| `DICE_CLUSTER_NAME` | 集群名称 | erda-jicheng | +| `DICE_PROTOCOL` | 协议 | https | ## 流水线环境变量 -> 以下环境变量，存在于流水线Action中 +> 以下环境变量，存在于[流水线](pipeline.md)Action中 | 变量名称 | 说明 | 示例 | |---------------------------------|---------------|-----------------------------------------------------------------| @@ -38,32 +38,32 @@ ## 应用运行时环境变量 -> 以下环境变量，存在于应用运行时 +> 以下环境变量，存在于[Runtime](../../../quick-start/premise.md#服务和-runtime) -| 变量名称 | 说明 | 示例 | -|-------------------------|----------------|---------------------------------------| -| `POD_IP` | Pod IP | 10.16.3.194 | -| `SELF_PORT` | Pod端口 | 25565 | -| `SELF_PORT(0-n)` | Pod开放的端口可能有n多个 | 25565 | -| `SELF_HOST` | Pod集群内部地址 | demo.demo-namespace.svc.cluster.local | -| `TERMINUS_TA_ENABLE` | 开启前端Ta监控 | true | -| `TERMINUS_AGENT_ENABLE` | 是否开启agent代理 | true | -| `DICE_RUNTIME` | Runtime ID | 19635 | -| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | -| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | -| `DICE_ORG_NAME` | 组织名称 | erda-development | -| `DICE_APPLICATION_ID` | 应用ID | 8766 | -| `DICE_CPU_ORIGIN` | CPU总大小 | 0.1 | -| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | -| `DICE_IS_EDGE` | 是否为边缘集群？ | true | -| `DICE_PROJECT_ID` | 项目ID | 1904 | -| `DICE_PROJECT_NAME` | 项目名称 | erda-development | -| `DICE_MEM_ORIGIN` | 内存总大小 | 128 | -| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | -| `DICE_WORKSPACE` | 应用工作空间 | test | -| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | -| `DICE_ORG_ID` | 组织ID | 633 | -| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | -| `DICE_HTTP_PORT` | http端口 | 80 | -| `DICE_USER_ID` | 用户ID | 22304 | -| `DICE_SERVICE_NAME` | service名称 | golang-check | \ No newline at end of file +| 变量名称 | 说明 | 示例 | +|-------------------------|-----------------------|---------------------------------------| +| `POD_IP` | Pod IP | 10.16.3.194 | +| `SELF_PORT` | Pod端口 | 25565 | +| `SELF_PORT(n)` | Pod开放的端口(n >= 0) | 25565 | +| `SELF_HOST` | Pod集群内部地址 | demo.demo-namespace.svc.cluster.local | +| `TERMINUS_TA_ENABLE` | 开启前端Ta监控 | true | +| `TERMINUS_AGENT_ENABLE` | 是否开启JavaAgent等监控Agent | true | +| `DICE_RUNTIME` | Runtime ID | 19635 | +| `DICE_MEM_REQUEST` | 申请的内存大小 | 256 | +| `DICE_MEM_LIMIT` | 最大内存大小 | 256 | +| `DICE_ORG_NAME` | 组织名称 | erda-development | +| `DICE_APPLICATION_ID` | 应用ID | 8766 | +| `DICE_CPU_ORIGIN` | CPU配置的原始值 | 0.1 | +| `DICE_CPU_REQUEST` | 申请的CPU大小 | 0.05 | +| `DICE_IS_EDGE` | 是否为边缘集群 | true | +| `DICE_PROJECT_ID` | 项目ID | 1904 | +| `DICE_PROJECT_NAME` | 项目名称 | erda-development | +| `DICE_MEM_ORIGIN` | 内存配置的原始值 | 128 | +| `DICE_APPLICATION_NAME` | 应用名称 | go-demo | +| `DICE_WORKSPACE` | 应用工作空间 | test | +| `DICE_CPU_LIMIT` | 最大CPU数 | 0.1 | +| `DICE_ORG_ID` | 组织ID | 633 | +| `DICE_CLUSTER_TYPE` | 集群类型 | kubernetes | +| `DICE_HTTP_PORT` | http端口 | 80 | +| `DICE_USER_ID` | 用户ID | 22304 | +| `DICE_SERVICE_NAME` | service名称 | golang-check | \ No newline at end of file