TSIA037.3-2023工业软件容器镜像校验接口规范_第1页
TSIA037.3-2023工业软件容器镜像校验接口规范_第2页
TSIA037.3-2023工业软件容器镜像校验接口规范_第3页
TSIA037.3-2023工业软件容器镜像校验接口规范_第4页
TSIA037.3-2023工业软件容器镜像校验接口规范_第5页
已阅读5页,还剩3页未读, 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

ICS35.020

T/SIA

中国软件行业协会团体标准

T/SIA037.3—2023

工业软件容器镜像校验接口规范

IndustrialSoftwareContainerImageVerificationInterface

Specification

学兔兔标准下载

2023-10-20发布2023-10-20实施

中国软件行业协会发布

T/SIA037.3—2023

工业软件容器镜像校验接口规范

1范围

本文件规定了一套工业软件领域容器镜像校验的接口命令和校验方式,在规定的版本控制、全局选

项和字符编码的前提下以确保容器镜像的完整性、真实性和可靠性。

本文件适用于开展监控不同类型工业软件容器镜像生命周期和校验工业软件容器镜像可靠性的工

作。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,

仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本

文件。

GB/T11457-2006信息技术软件工程术语

ISO/IEC2382-2015信息技术词汇

3术语和定义

GB/T11457-2006、ISO/IEC2382-2015中确立的以及下列术语和定义适用于本文件。

3.1

容器镜像containerimage

一种在容器化环境中用于打包和分发工业软件应用的标准化结构。

注:改编自OCI(2021)《OCIImageFormatSpecification(image-spec)》,OCI标准中定义了容器镜像的结构和

元数据格式。

3.2

控制台套接字consolesocket

一种用于容器与宿主机之间通信的机制,常用于网络编程和进程间通信。

3.3

语义化版本命名规范semanticversioning

一种软件版本号命名规范,通过定义一致的版本号格式,使软件包的版本管理变得更加明确、简单

和可靠。

学兔兔3.4标准下载

解包unpack

一种用于将一个容器镜像中文件系统解压缩出来的方式。

4缩略语

1

学兔兔标准下载

T/SIA037.3—2023

下列缩略语适用于本文件。

POSIX:便携式Unix操作系统接口(PortableOperatingSystemInterfaceforUNIX)

TIOCSTI:终端输入输出控制存储字符(TerminalInputOutputControlStoreCharacter)

TTYIOCTL:终端设备输入/输出控制(TerminalDeviceInput/OutputControl)

UTF:Unicode字符编码方式(UnicodeTransformationFormat)

5校验接口系统结构

工业软件容器镜像校验接口规范主要规定了一系列明确定义的接口命令和校验方式,包括容器镜

像获取、创建、启动、校验、解包和删除等关键环节。通过遵循这些接口规范,开发人员和用户能够按

照统一的标准对容器镜像进行操作,从而确保镜像的正确性和可靠性。如图1所示,展示了工业软件容

器镜像校验接口系统结构。

接口特征

版本控制全局应用全局选项字符编码

接口命令

镜像获取镜像启动镜像验证镜像解包

镜像创建镜像请求镜像处理镜像删除

图1工业软件容器镜像校验接口系统结构

6接口特征

6.1版本控制

校验接口使用semanticversioning2.0.0进行版本控制。校验接口版本独立于整个工业软件容

器镜像规范。

6.2全局应用

校验时必须提供可执行文件(在以下示例中称为funC)。该可执行文件必须支持符合以下模板的

命令:学兔兔标准下载

$funC[global-options]<COMMAND>[command-specific-options]<command-specific-

arguments>

6.3全局选项

2

T/SIA037.3—2023

没有需要,但可以支持以至少一个连字符(-)开头的选项。全局选项可以采用位置参数(示例:

--log-leveldebug)。命令名称不得以连字符(-)开头。选项解析必须使得funC<COMMAND>明确地是

<COMMAND>的调用(即使对于本文档中未指定的命令)。

6.4字符编码

此规范不包括字符编码,但校验时应符合其本机操作系统。示例:POSIX系统定义LANG和相关环

境变量以声明特定于语言环境的字符编码,因此en_US.UTF-8语言环境中的运行时应该将其状态以UTF-

8格式写入标准输出。

7接口命令

7.1容器镜像获取命令

get从进程获取用户的镜像。

a)参数

<ID>要获取的镜像

b)标准流

1)stdin:获取时不得尝试从其标准输入中读取。

2)stdout:未指定标准输出的处理。

3)stderr:获取时可以将诊断消息输出至stderr,并且这些行的格式未在本文档中指定。

c)退出码:容器被成功获取为0,有错误则为非0值。

调用者可以阻止此命令成功退出以触发创建后活动。

7.2容器镜像创建命令

create从包目录创建一个容器镜像。

a)参数

<ID>设置要创建的容器ID。

b)选项

1)bundle<PATH>覆盖包目录的路径(默认为当前工作目录)。

2)console-socket<FD>检验时必须通过文件描述符<FD>处的opensocket传递

pseudoterminalmaster。

3)pid-file<PATH>校验时必须将容器PID写入此路径。

c)标准流

如果process.terminal为true:

1)stdin:校验时不得尝试从其标准输入中读取。

2)stdout:未指定标准输出的处理。

学兔兔3)stderr:校验时可以将诊断消息输出至stderr,并且这些行的格式未在本文档中指定。标准下载

如果process.terminal不为true:

1)stdin:校验时必须将其标准输入文件描述符传递给容器进程,而不进行操作或修改。“没

有操作或修改”意味着校验时必须不寻找文件描述符,或关闭它,或读取或写入它,或

ioctl,或对其执行任何其他操作除了将其传递给容器进程。使用容器删除权限时,注意,

提供特权终端的文件描述符可能允许容器通过TIOCSTI或其他TTYioctl执行特权操作。

3

学兔兔标准下载

T/SIA037.3—2023

2)stdout:校验时必须将其标准输出文件描述符传递给容器进程,而不进行操作或修改。

3)stderr:当create以0代码存在时,校验时必须将其stderr文件描述符传递给容器进程

而不进行操作或修改。当create以非0代码退出时,校验时可以将诊断消息打印到stderr,

并且这些行的格式未在本文档中指定。

d)环境变量

LISTEN_FDS:传递的文件描述符的数量。示例:LISTEN_FDS=2意味着校验时必须将文件描述符3和

4传递给容器进程(除了标准流)以支持socket激活。

e)退出码:容器镜像被成功创建为0,有错误则为非0值。

其中console-socket使用的AF_UNIX处理校验时和服务器之间的请求和响应消息。socket类型必

须是SOCK_SEQPACKET或SOCK_STREAM。服务器必须为每个校验时请求发送一个响应。所有消息的正常

数据必须是UTF-8JSON。

请求:

所有请求必须包含一个类型属性,其值必须是以下字符串之一:

terminal,如果请求通过pseudoterminalmaster。当类型为终端时,请求还必须包含以下属

性:

container(string,REQUIRED)容器ID,由create设置。

消息的辅助数据(msg_control*)必须至少包含一个cmsghdr。第一个cmsghdr必须具有:

a)cmsg_type设置为SOL_SOCKET,

b)cmsg_level设置为SCM_RIGHTS

c)((int*)CMSG_DATA(cmsg))[0]设置为pseudoterminalmaster文件描述符。

响应:

所有响应必须包含一个类型属性,其值必须是以下字符串之一:

a)success,如果请求被成功处理。

b)error,如果请求没有被成功处理。

此外,响应可以包含以下任意属性:

c)message(string,OPTIONAL)一个描述该响应的短语。

7.3容器镜像启动命令

start从进程启动用户指定的容器镜像。

a)参数

<ID>要启动的容器镜像。

b)标准流

1)stdin:启动时不得尝试从其标准输入中读取。

2)stdout:未指定标准输出的处理。

学兔兔3)stderr:启动时可以将诊断消息输出至stderr,并且这些行的格式未在本文档中指定。标准下载

c)退出码:容器被成功启动为0,有错误则为非0值。

调用者可以阻止此命令成功退出以触发启动后活动。

7.4容器状态请求命令

state请求容器状态。

4

T/SIA037.3—2023

a)参数

<ID>要请求状态的容器。

b)标准流

1)stdin:请求时不得尝试从其标准输入中读取。

2)stdout:请求时必须将stateJSON打印至标准输出。

3)stderr:请求时可以将诊断消息输出至stderr,并且这些行的格式未在本文档中指定。

c)退出码:容器被成功创建为0,有错误则为非0值。

7.5容器镜像校验命令

validate从包目录测试校验容器。

a)参数

<ID>设置要校验的容器ID。

b)选项

1)bundle<PATH>覆盖包目录的路径(默认为当前工作目录)。

2)console-socket<FD>校验时必须通过文件描述符<FD>处的opensocket传递

pseudoterminalmaster;该协议如下所述。

3)pid-file<PATH>校验时必须将容器PID写入此路径。

c)标准流

1)stdin:校验时不得尝试从其标准输入中读取。

2)stdout:未指定标准输出的处理。

3)stderr:校验时可以将诊断消息输出至stderr,并且这些行的格式未在本文档中指定。

d)退出码:容器被成功创建为0,有错误则为非0值。

示例:

每个验证测试在validation/目录下都有一个.go文件,可以编译成.t文件并独立执行。

每个验证测试都会打印TAP输出。到目前为止,有两种验证测试,它们以不同的方式打印TAP输

出:

1)使用util.RuntimeInsideValidate和passthrough

在容器内启动进程runtimetest,runtimetest打印TAP输出。测试过程本身不得输出任何内

容,以避免将其输出与TAP输出混合。

2)使用util.RuntimeInsideValidate和encapsulation

与passthrough变体类似,但测试使用runtimetest的输出并为容器校验重新发出单个TAP结

果。为此,必须将TAP对象作为参数传递给util.RuntimeInsideValidate。

当校验时测试失败时,TAP输出以“notok”指示,但测试程序的退出状态通常保持为0。非0退出

状态表示测试程序中而不是校验时中有问题。

学兔兔7.6容器镜像解包命令标准下载

unpack解包容器镜像。

a)参数

<ID>要解包的镜像

b)标准流

5

学兔兔标准下载

T/SIA037.3—2023

1)stdin:解包时不得尝试从其标准输入中读取。

2)stdout:未指定标准输出的处理。

3)stderr:解包时可以将诊断消息输出至stderr,并且这些行的格式未在本文档中指定。

c)退出码:容器被成功创建为0,有错误则为非0值。

7.7容器镜像处理命令

kill向容器进程发送信号并进行处理。

a)参数

<ID>要发送信号的容器。

b)选项

--signal<SIGNAL>要发送的信号(默认为TERM)。处理时必须支持具有thePOSIXsemantics

的TERM和KILL信号。处理时可能支持额外的信号名称。在支持POSIX信号的平台上,处理时必须

使用POSIX信号实现此命令。在不支持POSIX信号的平台上,处理时可以使用替代技术实现此命令,只

要TERM和KILL保留其POSIX语义。非POSIX平台上的处理时作者应该将其TERM实现的文档提交到此

规范,以便处理时调用者可以配置容器进程以优雅地处理信号。

c)标准流

1)stdin:处理时不得尝试从其标准输入中读取。

2)stdout:未指定标准输出的处理。

3)stderr:处理时可以将诊断消息输出至stderr,并且这些行的格式未在本文档中指定。

d)退出码:容器被成功处理为0,有错误则为非0值。发送成功并不意味着信号被容器进程成功

接收或处理。

7.8容器镜像删除命令

delete容器进程退出后释放容器资源。

a)参数

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论