管道环境变量

概述

本页描述了管道中环境变量的可用性和使用情况。

您可以自定义您的工作流通过使用运行时可用的环境变量。例如，您的步骤可以根据管道名称和当前运行号构造文件名或构建ID。或者，您的步骤可以根据资源的状态执行不同的命令。

JFrog管道提供了通过环境变量访问管道和资源的有用内部信息。2022世界杯阿根廷预选赛赛程管道还提供了几种在管道执行期间将自己的环境变量注入运行时的简单方法。

页面内容

标准环境变量

所有正在执行的管道都可以使用这些环境变量。

环境变量	描述
`pipeline_name`	的`的名字`当前执行的管道的字符串。
`run_number`	当前正在执行的运行的编号。
`run_id`	运行的内部唯一ID。
`step_name`	的`的名字`在YAML中指定的步骤。
`step_id`	当前执行步骤的内部唯一ID。
`step_type`	的`类型`在YAML的字段中指定的步骤(例如，“Bash”，“DockerBuild”等)
`step_image_name`	用于运行该步骤的Docker映像的名称(例如。pipelines-docker.jfrog.io / jfrog / pipelines-u16node）.
`step_image_tag`	用于运行该步骤的Docker映像的标签。
`step_node_name`	用于运行step的节点名称(添加节点时用户配置)
`体系结构`	节点架构，例如x86_64
`step_node_id`	节点的内部唯一ID
`step_node_pool_name`	执行该步骤的节点池名称(创建池时用户配置)。
`step_url`	直接链接到步骤
`pipelines_api_url`	API的URL
`current_script_section`	onStart / onExecute onComplete等等
`operating_system`	step所在的操作系统，例如Ubuntu_16.04
`step_platform`	一样`操作系统`。
`builder_api_token`	用于在步骤执行期间调用管道API的令牌。内部使用，但用户可以访问。
`step_triggered_by_resource_name`	如果由资源触发，则`的名字`资源的。否则，此环境变量为空。
`step_triggered_by_step_name`	如果由另一个步骤触发，则步骤的名称。其他的空
`step_triggered_by_identity_name`	如果由用户触发，则用户名。其他的空
`step_affinity_group`	亲和组step所属。默认值与步骤名相同。
`running_in_container`	如果step在容器中运行，则为。如果在主机上运行，则为False。
`step_runtime`	设置为“image”或“host”
`路径`	当前执行的运行时环境中的PATH值。

管道

管道可以在其内部声明环境变量配置。这里声明的环境变量对管道中的所有步骤都可用。

管线:—name: my_pipeline configuration: environmentVariables: readOnly: env1: value1 env2: value2

步骤

步骤可以在其中声明环境变量配置管道中的一个步骤。

步骤:—name: step_1 type: Bash configuration: environmentVariables: env1: value1 env2: value2

来自此源的环境变量仅在声明它们的步骤可用。

集成

使用集成的步骤可以通过环境变量访问集成的属性。环境变量的形式为:

int_ <集成名称> _ <标记>

类的URL属性Artifactory集成命名myArtifactory通过一个环境变量:

$ printenv int_myArtifactory_url https://mycompany.com/artifactory/

您还可以通过使用集成的资源访问集成的属性。环境变量的形式为:

Res_ _<集成标签名称>_<标签> . sh

例如，图像资源中指定Artifactory集成注册表标签。因此，您可以访问Image资源所使用的Artifactory集成的URL模板如下:

$ printenv res_myImage_registry_url https://mycompany.com/artifactory/

有关更多信息，请参阅管道集成。

2022世界杯阿根廷预选赛赛程

中指定资源的步骤input2022世界杯阿根廷预选赛赛程resources可以通过环境变量访问该资源的属性。环境变量的形式为:

res_ <资源名称> _ <标记>

例如，您可以访问imageName的属性图像资源模板通过一个环境变量:

$ printenv res_myImage_imageName jfrog.local:5000/alpine37

有些资源维2022世界杯阿根廷预选赛赛程护可以作为环境变量访问的附加属性。这些资源类型包括:

GitRepo

有关更多信息，请参阅管道资源2022世界杯阿根廷预选赛赛程。

基于资源的状态

中指定的资源中还可以添加自己的属性output2022世界杯阿根廷预选赛赛程resources使用write_output效用函数。这可以用来创建有状态的管道。

新附加的属性可以作为表单的环境变量访问res_{资源名}_{密钥名}。例如:

write_output myImage sport="baseball" equipment="bat" field="diamond"

将在资源中创建三个属性模板。当在步骤中指定资源时inputsource，这些属性可以作为以下环境变量访问:

$ printenv res_myImage_baseball棒球$ printenv res_myImage_equipment bat $ printenv res_myImage_field钻石

有关运行状态的详细信息，请参见创建有状态管道。

运行状态

管道可以定义自己的环境变量，并将它们添加到管道的运行状态。这些将对管道运行中的所有步骤可用。

使用运行状态管理的实用函数向当前运行状态添加新的环境变量。例如，步骤执行块中的以下行:

英雄="超人"反派="莱克斯·卢瑟"

将创建两个环境变量，用于管道运行的当前和未来所有步骤:

$ printenv英雄超人$ printenv恶棍莱克斯卢瑟

有关运行状态的详细信息，请参见创建有状态管道。

管道状态

您的管道可以定义自己的环境变量，并将它们添加到管道状态。这些将可用于该管道的所有运行。

使用用于管道状态管理的实用函数向当前运行状态添加新的环境变量。例如，步骤执行块中的以下行:

Add_pipeline_variables动物="狗"蔬菜="胡萝卜"

将创建两个环境变量，用于定义它们的管道的所有运行:

$ printenv动物狗$ printenv蔬菜胡萝卜

有关管道状态的详细信息，请参见创建有状态管道。

内容

空间工具