You need to enable JavaScript to run this app.
导航
生信操作系统Bio-OS
  • 文档首页
    • /
  • 生信操作系统Bio-OS

Notebook使用自定义镜像

最近更新时间：2023.03.21 14:19:43

首次发布时间：2023.03.21 14:19:43

我的收藏

生信操作系统Bio-OS支持您以自己的镜像作为Notebook的启动环境。
这是一个分步指南，用于：

  1. 构建和发布自定义Docker镜像

  2. 使用修改后的Docker镜像在Bio-OS上运行Notebook

注意

在您使用Notebook自定义镜像功能前，以下三点请知悉

  1. 自定义镜像必须基于Bio-OS提供的基础镜像，否则可能会导致Notebook启动失败

  2. 自定义镜像会拉取您设置的镜像，这个过程中可能会产生流量费

  3. 过大的镜像可能会导致容器镜像启动超时，不建议您使用15G以上的镜像

  1. 下载基础镜像Dockerfile

首先您需要下载基础镜像的Dockerfile，您有以下两种方式进行下载

  • 您可以直接访问： https://gitee.com/bio2s/bioos-baseimage，并点击克隆/下载

  • 您也可以通过 git clone https://gitee.com/bio2s/bioos-baseimage.git 直接克隆到本地

现在您可以在本地文件夹中找到刚下载的bioos-baseimage文件夹，这个文件夹中的Dockerfile就是我们需要修改的基础镜像Dockerfile。

  1. 修改Dockerfile

2.1 打开Dockerfile之后，文件中#install your own package here这句描述下新增一行，比如 RUN pip install -i https://pypi.tuna.tsinghua.edu.cn/simple gsutil
这句代码会为您在基础镜像的基础上安装gsutil这个工具包，修改完成后点击保存。


  1. 设置镜像push地址

本小节将以火山镜像仓库作为镜像推送地址，也建议您使用火山镜像仓库作为自定义镜像的存储地址。
在推送镜像之前，您需要开通火山镜像仓库并在镜像仓库中创建【命名空间】，并在命名空间中创建【制品仓库】，具体指南如下：推送和拉取镜像 镜像仓库-火山引擎

注意

您需要注意目前您的镜像需要设置为公共读方可允许Bio-OS启动Notebook时拉取镜像。另外您的镜像仓库也需要在访问控制中设置允许公网访问，如下图所示。



  1. 构建并推送自定义镜像

注意

您必须从包含dockerfile的目录中运行您的命令。Docker只能识别名为Dockerfile的dockerfile（没有扩展名），因此您可以在计算机上拥有任意数量的dockerfile，但它们需要位于单独的文件夹中，每个文件夹只有一个dockerfile。当您执行Docker build命令时，它将在您在终端中查看的目录中查找dockerfile。该目录中必须有一个名为Dockerfile的文件，否则该命令将失败。

4.1 使用以下命令进入 bioos-baseimage目录：

cd bioos-baseimage

4.2 执行一下Docker build命令(注意不要漏掉最后的".", "." 代表使用当前路径的dockerfile):

Docker build -t RESPOSITORY_NAME/DOCKER_IMAGE_NAME:TAG_NAME .


build的过程可能长达10多分钟
4.3. 执行下面的推送命令将您的自定义镜像上传到您的镜像仓库（推送和拉取镜像 镜像仓库-火山引擎）:

Docker push RESPOSITORY_NAME/DOCKER_IMAGE_NAME:TAG_NAME

这个过程可能也会长达10分钟时间，取决于网络和您的镜像大小


  1. Notebook运行配置选择自定义镜像

5.1 在Notebook列表页面点击【运行资源配置】，在运行资源配置中选择镜像来源【自定义】，并复制您的镜像地址

点击【更新环境】

  1. 启动Notebook并等待容器启动完成

选择一个Notebook，并点击【编辑】，Notebook的启动过程会包含镜像的拉取，因此时间可能会比较长，请耐心等待。