Skip to content

Commit 7dedd56

Browse files
authored
Feat/update docker images docs (#163)
* update regression intro page * update some wording * update docker images push page * update wording
1 parent 3293a61 commit 7dedd56

File tree

11 files changed

+51
-54
lines changed

11 files changed

+51
-54
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,6 @@ yarn-error.log*
2727

2828
# oss
2929
.ossutil_checkpoint
30+
31+
# generated pdf files
32+
/pdf

docs/1-coscene-intro.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -5,52 +5,52 @@ id: intro
55

66
# 总览
77

8-
欢迎使用刻行时空(coScene)平台,刻行时空是一个基于多模态场景数据的运维和研发平台,帮助企业和用户管理繁复的设备和行为数据。在多模态数据爆炸性增长的今天,coScene 提供了一个公开、即时可用、云原生、且中立的解决方案。
8+
欢迎使用刻行时空(coScene),刻行时空是一个基于多模态场景数据的运维和研发平台,帮助企业和用户管理繁复的设备和行为数据。在多模态数据爆炸性增长的今天,刻行时空提供了一个公开、即时可用、云原生、且中立的解决方案。
99

1010
## 功能简介
1111

1212
### 数据管理和可视化
1313

14-
多模态数据尺寸巨大,复杂的智能体机器人可以在几分钟能就产生超过 10 GB 的数据。原始的数据难以直接理解,格式复杂且缺乏统一标准,数据来源五花八门,处理难度大门槛较高。针对这些难点,coScene 提供了一套完整的多模态数据管理和使用方案。用户可以通过 API,网页应用,和桌面软件等方式,对场景数据进行高效利用。
14+
多模态数据尺寸巨大,复杂的智能体机器人可以在几分钟能就产生超过 10 GB 的数据。原始的数据难以直接理解,格式复杂且缺乏统一标准,数据来源五花八门,处理难度大门槛较高。针对这些难点,刻行时空提供了一套完整的多模态数据管理和使用方案。用户可以通过网页应用、API、CLI、端侧软件等方式,对场景数据进行高效利用。
1515

1616
### 边端助理和规则引擎
1717

18-
coScene 为您的智能体设备提供了开箱即用的边端助理 - Cos Agent,来帮助您根据事件、环境信息、告警等有关信息进行边端设备
18+
刻行时空为您的智能体设备提供了开箱即用的边端软件 coScout,来帮助您根据事件、环境信息、告警等有关信息进行边端设备
1919
的数据截取、压缩、上传等一系列动作。无论您采用了什么样的宿主操作系统和软件,平台的边端助理都可以在简单配置后适配您
2020
的运行环境,快速识别您的设备开始工作。
2121

22-
搭配边端助理的是强大的云端规则引擎编辑器,您可以在云端定义复杂的事件和告警等触发条件,然后下发给您选择的设备。无需再次的部署或者 OTA 就可以调整边端助理的行为表现,采集真正有用的数据
22+
搭配边端助理的是强大的云端规则引擎编辑器,您可以在云端定义事件和告警等触发条件,然后下发给您选择的设备。无需再次的部署或者 OTA 就可以调整边端助理的行为表现,采集真正有用的数据
2323

2424
### 自定义您的工作流
2525

26-
使用 coScene 的工作流引擎,您可以方便的在多模态场景数据上构建大规模的工作流应用而不用担心数据的准备和计算资源的调度。在工作流模版管理页面中,您不仅可以找到团队成员制作的工作流模版,也可以发现由刻行官方提供的处理各种数据类型的工作流模版
26+
使用刻行时空的工作流引擎,您可以方便的在多模态场景数据上构建大规模的工作流应用而不用担心数据的准备和计算资源的调度。在工作流模版管理页面中,您不仅可以找到团队成员制作的工作流模版,也可以使用由刻行官方提供的处理各种数据类型的工作流模版
2727

2828
### 语义搜索引擎
2929

30-
coScene 的语义搜索引擎提供了一个开放的搜索和发现框架,用户可以在平台上构建自己的场景分类库和对应的索引,从而实现对场景数据的快速检索和发现。这在多模态场景数据的管理中非常有用,例如在自动驾驶中,用户可以通过搜索引擎快速发现某个特定的交通标志,或者在机器人中,用户可以通过搜索引擎快速发现某个特定的物体。
30+
刻行时空的语义搜索引擎提供了一个开放的搜索和发现框架,用户可以在平台上构建自己的场景分类库和对应的索引,从而实现对场景数据的快速检索和发现。这在多模态场景数据的管理中非常有用,例如在自动驾驶中,用户可以通过搜索引擎快速发现某个特定的交通标志,或者在机器人中,用户可以通过搜索引擎快速发现某个特定的物体。
3131

3232
## 系统概念
3333

34-
登录 coScene 之后,您立即就可以使用平台的全部正式功能,下面是一些主要概念的简介。
34+
登录[刻行时空](https://coscene.cn)之后,您立即就可以使用平台的全部正式功能,下面是一些主要概念的简介。
3535

3636
### 组织(Organization)
3737

38-
来自同一个公司、组织、或者团体的用户都将被分配在同一个组织中。组织的管理员可以对不同的用户设置不同的权限来对数据的访问做精确的控制。
38+
来自同一个公司、组织、或者团体的用户会共享同一个组织。组织的管理员可以对不同的用户设置不同的权限来对数据的访问做精确的控制。
3939

4040
### 项目(Project)
4141

42-
项目是 coScene 最小的权限管理单位,用户可以使用项目来对数据的可见性进行管理。无论是想在组织内共享该项目的所有数据,还是想对
42+
项目是刻行时空最小的权限管理单位,用户可以使用项目来对数据和设备资源的可用性进行管理。无论是想在组织内共享该项目的所有数据,还是想对
4343
还在研发中的项目数据进行保密,用户都可以使用项目来进行逻辑分割。项目中的记录,一刻等数据都属于项目,继承项目在组织中的可见性。
4444

4545
### 记录(Record)
4646

47-
记录是 coScene 的核心概念,记录包含着用户想要聚合在一起的所有数据。单一的 ROS Bag 可能并不能代表一段测试的全貌,往往需要再
47+
记录是刻行时空的核心概念,记录包含着描述特定场景的所有数据的集合。单一的 ROS Bag 可能并不能代表一个任务的全貌,往往需要再
4848
加上配置文件、地图文件、测试报告等一系列的辅助文件一起。
4949

5050
### 一刻(Moment)
5151

52-
一个记录可能是一个很长的数据片段,比如一次完整的自动驾驶的开启直到结束。在这中间,会有很多有意思的数据点,比如一个
53-
加塞,一个紧急避让等等。这些有意思的数据点才是海量的数据中最有质量的片段。coScene 为用户提供了一刻(Moment)的模型来标注
52+
一个记录可能是一个很长的数据片段,比如一次完整的自动驾驶的开启直到结束。在这个过程中,会有很多有意思的数据点,比如一个
53+
加塞,一个紧急避让等等。这些有意思的数据点才是海量的数据中最有质量的片段。刻行时空为用户提供了一刻(Moment)的模型来标注
5454
和管理这样的时间点,方便用户在后续的数据处理中更好的发现和利用高质量的数据片段。
5555

5656
参考我们的快速开始指南,了解更多平台的功能。

docs/4-recipes/13-image/1-intro.md

+13-16
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,21 @@ sidebar_position: 1
44

55
# 关于镜像
66

7-
Docker 镜像是轻量级的、可执行的软件包,包含了运行某个软件或应用所需的所有内容——代码、运行时环境、库、环境变量和配置文件。Docker 镜像是构建 Docker 容器的基础,每个镜像都是不可变的,当运行镜像时,它会变成一个容器。
7+
Docker 镜像是一个可执行的软件包,它包含运行应用程序所需的所有内容(包括代码、运行环境、系统工具、系统库和配置等)。镜像是构建 Docker 容器的基础,具有以下主要特点:
88

9-
Docker 镜像的特点包括:
9+
1. **分层存储**:镜像由多个层级构成,修改时只需在顶部添加新层,大幅提高构建和分发效率。
10+
2. **共享重用**:不同镜像可以共享基础层,有效节省存储空间和网络带宽。
11+
3. **不可变性**:镜像创建后其内容不可更改,所有修改仅发生在容器层。
12+
4. **版本控制**:支持标签(Tag)管理,便于版本控制和回滚操作。
13+
5. **轻量级**:采用按需加载机制,确保容器快速启动。
14+
6. **可移植性**:包含完整的运行环境和依赖,可在任何支持 Docker 的平台上运行。
1015

11-
1. **分层存储**:Docker 镜像由多层构成,每一层代表镜像构建过程中的一个步骤。当修改镜像时,只需添加新的层,不需要更改既有层,这使得镜像的分发和更新非常高效。
12-
13-
2. **共享与重用**:多个镜像可以共享相同的层,如果不同的镜像使用相同的基础层,那么这些层在机器上只需存储一份,可以节约空间并提高效率。
14-
15-
3. **不可变性**:镜像一旦创建,其内容就不可更改。所有对容器的修改(如添加新文件或更改现有文件)都将发生在容器的可写层,而不影响底层镜像。
16-
17-
4. **版本控制和回滚**:Docker 镜像可以通过标签进行版本控制,方便管理和回滚到特定的版本。
18-
19-
5. **轻量级**:由于镜像是按需加载各个层,因此它们是轻量级的,启动速度快,便于快速扩展和分发。
20-
21-
6. **可移植性**:镜像包含了运行应用所需的所有依赖,可以在任何支持 Docker 的平台上运行,确保了一致的运行环境。
22-
23-
Docker 镜像通常从一个基础镜像开始构建,通过编写 Dockerfile(一个包含自定义指令集的文本文件)来定制镜像。这些自定义镜像可以存储在本地,也可以上传到公共或私有的镜像仓库(如 Docker Hub)中,供他人使用。使用 Docker 命令 `docker pull` 可以从仓库中拉取镜像到本地,`docker run` 命令则用于基于镜像启动一个新的容器。
16+
镜像通过 Dockerfile 构建,可存储在本地或镜像仓库中。您可以选择使用自有的镜像仓库或刻行平台提供的镜像仓库服务。如果使用自有镜像仓库,需要手动配置认证信息,以确保刻行平台具有访问外部镜像仓库的必要权限。
2417

2518
# 关于刻行镜像仓库
2619

27-
刻行平台提供了一个私有的镜像仓库,让用户无须自行搭建,能够将现有的镜像快速的上传至刻行镜像仓库,从而立即可以在刻行平台使用相关的镜像,搭建业务流程,提升研发效率。如[自动化](../12-action/1-quickstart.md)[批量测试](../8-regression/1-intro.md)中均支持使用刻行镜像仓库镜像。
20+
刻行平台提供专业的私有镜像仓库服务。在刻行时空平台内部使用该服务时,无需额外配置认证过程,具有以下优势:
21+
22+
- 支持快速上传和管理现有镜像
23+
- 可在平台内直接使用托管的镜像
24+
- 与平台[自动化服务](../12-action/1-quickstart.md)[批量测试](../8-regression/1-intro.md)等功能无缝集成

docs/4-recipes/13-image/3-push-image.md

+8-14
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ sidebar_position: 3
44

55
# 推送镜像
66

7-
本文主要演示了推送用户的镜像至刻行镜像仓库。
8-
9-
## 前置条件
10-
11-
已经存在编译好的镜像或者按照[打包镜像](./2-build-image.md)的过程,打包好了测试镜像。
7+
准备好镜像之后,我们可以选择将镜像推送到 DockerHub 这样的镜像服务或者使用刻行的镜像仓库
128

139
## 推送镜像至 Docker Hub
1410

@@ -18,18 +14,16 @@ sidebar_position: 3
1814

1915
### 1. 认证和登录刻行的镜像仓库
2016

21-
登录刻行平台,在右上角用户设置下拉面板中,访问【个人设置】,在【个人设置】页面中,访问[【安全】](https://coscene.cn/profile?section=security)页面。
22-
23-
点击生成访问命令,获取登录刻行镜像仓库的命令和密码
17+
登录刻行平台,在右上角用户设置下拉面板中,选择[【组织管理】-【镜像】](https://coscene.cn/org/images)
2418

25-
![generate-cr-token](../img/generate-cr-token.png)
19+
![docker-images-page](../img/4-13-docker-images-page.png)
2620

27-
![login-cr](../img/login-cr.png)
21+
在镜像页面中,选择访问或推送镜像,获取认证所需的信息
2822

29-
在命令行中输入包含用户名的登录,使用之前获得的认证凭证进行认证
23+
![generate-docker-auth](../img/4-13-generate-docker-auth.png)
3024

31-
![docker-login](../img/docker-login.png)
25+
返回命令行,使用刚才获取的登录命令和密码登录刻行仓库
3226

33-
### 推送镜像
27+
![docker-login](../img/4-13-docker-login.png)
3428

35-
完成构建之后,就可以使用 `docker push` 将镜像推送到刻行的镜像仓库了。
29+
完成认证之后,就可以使用 `docker push` 将镜像推送到刻行的镜像仓库了。

docs/4-recipes/8-regression/1-intro.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,25 @@ sidebar_position: 1
2626

2727
点击进入项目的「批量测试」页面,根据页面提示创建一个批量测试:
2828

29-
![regression](../img/regression.png)
29+
![regression](../img/4-8-regression-intro.png)
3030

3131
以下步骤概述为你提供了使用批量测试功能的一个基本流程:
3232

33-
1. 将测试数据上传到刻行项目中,按照记录存储
33+
1. 准备测试环境
3434

35-
2. 确保组织内有相应可用镜像,或推送镜像至刻行平台
35+
- 准备批量测试环境的 Docker 镜像
36+
- 将镜像推送至公开平台或[刻行时空镜像仓库](../13-image/3-push-image.md)
37+
- 将测试数据上传到刻行项目中并按「记录」存储
3638

37-
3. 在「测试套件管理」页面上传或在线编辑配置文件,得到要执行批量测试的测试套件和相应配置参数
39+
2. 配置测试内容
3840

39-
4. 在「测试包管理」页面上传测试包文件,生成一个测试包版本;如果上传的测试包满足测试套件关联触发条件,则会自动触发批量测试
41+
- 在「测试套件管理」页面上传或编辑配置文件
42+
- 设置测试套件和相应配置参数
43+
- 在「测试包管理」页面上传测试包文件
4044

41-
5. 在「批量测试」页面点击按钮,选择运行参数(测试包版本、测试套件等)后运行批量测试;或直接在本地通过命令行运行批量测试
42-
43-
6. 点击批量测试查看运行进度与测试结果
45+
3. 执行与监控
46+
- 在「批量测试」页面选择运行参数(测试包版本、测试套件等)
47+
- 启动批量测试(可通过界面或命令行方式)
48+
- 实时监控测试进度并查看测试结果
4449

4550
更多具体步骤请参见后续章节的详细说明。
46-
47-
<br />
268 KB
Loading
Loading
265 KB
Loading

i18n/en/docusaurus-plugin-content-docs/current/1-coscene-intro.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Welcome to the coScene platform. coScene is an operational and development platf
1313

1414
Multimodal data is large in size, difficult to understand in its raw form, complex in format, and lacks a unified standard. The sources of this data are varied, making it challenging and high-threshold to handle. Addressing these challenges, coScene offers a complete set of scene data management and usage solutions. Users can efficiently utilize scene data through APIs, web applications, and desktop software.
1515

16-
### Cos Agent and Rule Engine
16+
### coScout and Rule Engine
1717

18-
coScene provides an out-of-the-box Cos Agent, to help your intelligent devices perform a series of actions such as data capture, compression, and upload based on events, environmental information, alarms, and other relevant information. Regardless of the host operating system and software you use, Cos Agent can always adapt to your runtime environment with simple configuration and quickly identify your devices to start working.
18+
coScene provides an out-of-the-box on-device helper - coScout, to help your intelligent devices perform a series of actions such as data capture, compression, and upload based on events, environmental information, alarms, and other relevant information. Regardless of the host operating system and software you use, Cos Agent can always adapt to your runtime environment with simple configuration and quickly identify your devices to start working.
1919

2020
Accompanying Cos Agent is a powerful cloud-based rule engine and its editor, allowing you to define complex event and alarm trigger conditions in the cloud and then deploy them to your selected devices. This enables you to adjust the behavior of the edge assistant and collect truly useful data without the need of redeployment or OTA updates.
2121

0 commit comments

Comments
 (0)