swarmspawner 0.1.0

Container_spec

命令 和 参数 取决于您所使用的镜像。

如果您使用 Jupyter docker-stack 中的其中一个镜像，则需要将 参数 指定如下：/usr/local/bin/start-singleuser.sh

如果您使用特定的镜像，那么指定正确的命令就是您的责任。

c.SwarmSpawner.container_spec = {
              # The command to run inside the service
              # 'args' : ['/usr/local/bin/start-singleuser.sh'], # (list)
              'Image' : 'YourImage',
              'mounts' : mounts
      }

注意：在容器规范中，参数 设置 Dockerfile 中 CMD 的等效项，命令 设置 ENTRYPOINT 的等效项。笔记本服务器命令不应该设置为 ENTRYPOINT，因此通常使用 参数，而不是 命令，来指定如何启动笔记本服务器。

有关更多信息，请参阅这个 问题。

绑定主机目录

使用 'type':'bind'，您可以将主机上的本地目录挂载到容器内部。

请记住，源应该在您创建服务的节点上存在。

notebook_dir = os.environ.get('NOTEBOOK_DIR') or '/home/jovyan/work'
c.SwarmSpawner.notebook_dir = notebook_dir

mounts = [{'type' : 'bind',
        'source' : 'MountPointOnTheHost',
        'target' : 'MountPointInsideTheContainer',}]

挂载命名卷

使用 'type':'volume'，您可以将 Docker 卷挂载到容器内部。如果该卷不存在，则会创建。

mounts = [{'type' : 'volume',
        'source' : 'NameOfTheVolume',
        'target' : 'MountPointInsideTheContainer',}]

命名路径

对于卷和绑定两种类型，您都可以在源中指定一个 {username}。

mounts = [{'type' : 'volume',
        'source' : 'jupyterhub-user-{username}',
        'target' : 'MountPointInsideTheContainer',}]

用户名将是用户名的哈希版本。

挂载匿名卷

此类卷将在服务删除时被删除。

mounts = [{'type' : 'volume',
        'target' : 'MountPointInsideTheContainer',}]

资源规范

您还可以为每个服务指定一些资源。

c.SwarmSpawner.resource_spec = {
                'cpu_limit' : 1000, # (int) – CPU limit in units of 10^9 CPU shares.
                'mem_limit' : int(512 * 1e6), # (int) – Memory limit in Bytes.
                'cpu_reservation' : 1000, # (int) – CPU reservation in units of 10^9 CPU shares.
                'mem_reservation' : int(512 * 1e6), # (int) – Memory reservation in Bytes
                }

使用用户选项

您可以使用 user_options 设置参数。

# To use user_options in service creation
c.SwarmSpawner.use_user_options = False

要控制服务的创建，您有两种方式：使用 jupyterhub_config.py 或 user_options。

请记住，您最终只是使用 Docker 引擎 API。

如果使用，user_options 将会覆盖 jupyter_config.py 中的服务设置。

如果您设置 c.SwarmSpawner.use_user_option = True，则启动器将使用通过表单或 JSON 主体传递的字典进行操作时使用的 Hub API。

启动器期望一个包含以下键的字典

user_options = {
        'container_spec' : {
                # (string or list) command to run in the image.
                'args' : ['/usr/local/bin/start-singleuser.sh'],
                # name of the image
                'Image' : '',
                'mounts' : mounts,
                'resource_spec' : {
                        # (int) – CPU limit in units of 10^9 CPU shares.
                        'cpu_limit': int(1 * 1e9),
                        # (int) – Memory limit in Bytes.
                        'mem_limit': int(512 * 1e6),
                        # (int) – CPU reservation in units of 10^9 CPU shares.
                        'cpu_reservation': int(1 * 1e9),
                        # (int) – Memory reservation in bytes
                        'mem_reservation': int(512 * 1e6),
                        },
                # list of constrains
                'placement' : [],
                # list of networks
                'network' : [],
                # name of service
                'name' : ''
                }
        }

在 Swarm 模式下 Docker 引擎中 Jupyter notebook 服务的名称

当 JupyterHub 启动一个新的 Jupyter notebook 服务器时，服务的名称将是 {service_prefix}-{service_owner}-{service_suffix}

您可以通过这种方式更改 service_prefix

Docker 服务的名称前缀

c.SwarmSpawner.service_prefix = "jupyterhub"

service_owner 是哈希过的 user.name 的 hexdigest()。

在具有命名服务器的情况下（用户有多个服务器），service_suffix 是服务器的名称，否则始终为 1。

下载镜像

Swarm 模式下的 Docker 引擎会自动从仓库下载镜像。如果镜像在远程仓库或本地可用，否则会出错。

由于在启动服务之前需要完成镜像的下载，所以更长的超时（默认为 30 秒）会更好。

c.SwarmSpawner.start_timeout = 60 * 5

您可以使用 Jupyter docker-stacks 中的所有 Docker 镜像。

贡献

如果您想为项目做出贡献，请阅读 贡献文档。

对于 开发安装，请克隆 存储库，然后从源安装。

git clone https://github.com/cassiny/SwarmSpawner
cd SwarmSpawner
pip install -r requirements/base.txt -e .