ADE 开发环境

2020-09-21 本文已影响0人水之心

参考 ADE Development Environment

ADE 开发环境（ADE，发音为 [ey]-[dee]-[ee]）是一个基于 Docker 的模块化工具，可确保项目中的所有开发人员都拥有一个共同的，一致的开发环境。

与 ADE 开发人员一起：

有信心一台计算机上的内容，将在所有启用了 ADE 的计算机上都起作用
可以轻松地安装新的软件包和依赖项，并且可以轻松地恢复环境到其原始状态
可以挂载不同的卷（可以是独立的库，IDE 和其他工具），并且可以在这些卷的版本之间轻松切换，而不会影响环境的其他部分

1 安装

Requirements：

Docker 19.03 或更高版本，请按照 instructions for your OS
如果主机具有 NVIDIA 图形卡，请安装 nvidia-container-toolkit：查看 NVIDIA Docker’s Quickstart 了解详细信息

ADE 是模块化的 Docker-based 工具，它确保所有的开发者构建项目时有一个共同的、一致的开发环境。

请遵循如下安装说明：

验证是否满足 requirements 列出的要求
从 ade-cli 项目的 Releases 页面下载静态链接的二进制文件
命名二进制 ade 并将其安装在 PATH 中（在 Ubuntu 上，建议使用 /usr/local/bin）
修改可执行文件 ade 的权限: chmod +x ade
检查是否安装成功：

$ which ade
/path/to/ade
$ ade --version
<version>

ADE 从基本映像创建 Docker 容器，并在 /opt 中安装其他只读卷。基本映像提供了开发工具（例如 vim，udpreplay 等），而卷则提供了其他开发工具（例如 IDE，大型第三方库）或发行的软件版本（例如最新的 AutowareAuto 版本）。此外，ADE 使映像和卷的版本之间的切换变得容易。

要在 Ubuntu 20.04 计算机上安装 ADE，请执行以下步骤：

$ mkdir study
$ cd study/
$ wget https://gitlab.com/ApexAI/ade-cli/uploads/f6c47dc34cffbe90ca197e00098bdd3f/ade+x86_64
$ mv ade+x86_64 ade
$ chmod +x ade
$ ./ade --version
4.0.0
$ ./ade update-cli
$ ./ade --version
4.2.0

有关如何在脱机计算机上安装 ADE（ade-cli，ADE 基本映像和 ADE卷）的信息，请参阅 Offline Installation。

要更新 ade-cli，请运行 ade update-cli。如果有较新的版本，ade 将提示您确认，下载新版本，并自行替换。

上面的方式是局部安装的方法，全局安装方式是：

$ git clone https://gitlab.com/ApexAI/ade-cli
$ cd ade-cli
$ ./osx-install
$ which ade
~/.local/bin/ade
$ ade --version
<version>

更加方便是是直接使用 pip：

$ pip install ade-cli

2 设定 ADE

要为项目设置 ADE，请准备两个主要组件：

base-image是提供项目的所有程序和依赖项的 Docker 映像。有关详细信息，请参见 Creating a custom base image。
.aderc 文件指定要启动的 Docker 映像以及任何其他 docker run 的参数。有关详细信息，请参见 The .aderc File 。

除了 base-image 和 .aderc 文件外，建议使用 volumes 来提供大型独立程序和库。Volumes使项目可以更新 ADE 的不同组件，而无需用户下载越来越大的 image。有关详细信息，请参见 Creating a custom volume。

3 外部接口

ADE 还可以配置为使用外部接口（网络设备，端口和/或 USB 设备）来获取例如传感器的信息：

Starting ADE with macvlan network configuration 和 Mounting ports to ADE 阐述了如何配置 ADE 的网络与端口
Mounting USB devices in ADE 说明了如何使 USB 设备在 ADE 中可用
NVIDIA Docker in ADE 说明了如何将 NVidia Docker 与 ADE 集成

4 用法¶

The goal of this section is to explain how to use ADE on a project that provides and ADE configuration. See Setup for more information.

4.1 ADE Home¶

ADE 在主机上需要一个目录，该目录将作为用户的主目录挂载在容器中。该文件将填充点文件，并且必须与主机上用户的主目录不同。如果您将 ADE 用于多个项目，建议为每个项目使用专用的 ADE 主目录（home）。

ADE 将查找一个包含名为 .adehome 的文件的目录，该文件从当前工作目录开始，并继续到父目录，以标识要挂载的 ADE 主目录。

mkdir adehome
cd adehome
touch .adehome

首次运行 ade 时，它将首先提示您输入身份验证令牌，然后下载 .aderc 文件中配置的所有 Docker 映像。

$ ade start --update
...
ADE startup completed.
$ ade enter
ade$ <= Note that the prompt changes

4.2

待更 Usage¶