https://github.com/manics/repo2shellscript

A plugin for repo2docker that outputs a directory with a shell-script and required files
https://github.com/manics/repo2shellscript

jupyter packer repo2docker repo2packer repo2vm

Last synced: 2 months ago
JSON representation

A plugin for repo2docker that outputs a directory with a shell-script and required files

• Host: GitHub
• URL: https://github.com/manics/repo2shellscript
• Owner: manics
• License: bsd-3-clause
• Created: 2020-08-01T23:09:06.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-14T16:22:03.000Z (3 months ago)
• Last Synced: 2024-10-30T09:37:08.057Z (2 months ago)
• Topics: jupyter, packer, repo2docker, repo2packer, repo2vm
• Language: Jupyter Notebook
• Homepage:
• Size: 169 KB
• Stars: 13
• Watchers: 4
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# repo2shellscript (and Packer)

[![Build](https://github.com/manics/repo2shellscript/workflows/Build/badge.svg)](https://github.com/manics/repo2shellscript/actions)

`repo2shellscript` is a plugin for [repo2docker](http://repo2docker.readthedocs.io) that outputs a directory with a shell-script and required files.

It does not build a container image, instead you should take the output and use it to build some other execution environment, either by running the output scripts or using one of the included Packer templates.

## Installation

This plugin is still in development.

    pip install -U git+https://github.com/manics/repo2shellscript.git@main

## Running

Simply include `--engine shellscript` in the arguments to `repo2docker`:

    repo2docker --engine shellscript --no-run repository/to/build

Since this does not build anything you must pass `--no-run`.

Example:

    $ repo2docker --engine shellscript --user-name test --user-id 1002 --no-run https://github.com/binder-examples/conda

    Picked Git content provider.

    Using CondaBuildPack builder

    Output directory: /home/test/repo2shellscript-output/r2dhttps-3a-2f-2fgithub-2ecom-2fbinder-2dexamples-2fconda5778653

    Build script: /home/test/repo2shellscript-output/r2dhttps-3a-2f-2fgithub-2ecom-2fbinder-2dexamples-2fconda5778653/repo2shellscript-build.bash

    Start script: /home/test/repo2shellscript-output/r2dhttps-3a-2f-2fgithub-2ecom-2fbinder-2dexamples-2fconda5778653/repo2shellscript-start.bash

    Systemd service: /home/test/repo2shellscript-output/r2dhttps-3a-2f-2fgithub-2ecom-2fbinder-2dexamples-2fconda5778653/repo2shellscript.service

    Packer templates: /home/test/repo2shellscript-output/r2dhttps-3a-2f-2fgithub-2ecom-2fbinder-2dexamples-2fconda5778653/repo2docker.pkr.hcl /home/test/repo2shellscript-output/r2dhttps-3a-2f-2fgithub-2ecom-2fbinder-2dexamples-2fconda5778653/repo2vagrant.pkr.hcl

    User: test

    Jupyter token: 4973fff2-3a21-4f24-a179-379e96a363d6

- Output directory: should contain everything required to build the environment, e.g. you could copy this to a Ubuntu 18.04 virtual machine

- Build script: a bash script that will build the environment, must be run as `root`

- Start script: a bash script that should be used to start the environment

- Systemd service: an alternative to the start script

- Packer templates: Packer templates for Vagrant VirtualBox and Docker

- User: The user that should be used to run the start script

- Jupyter token: A generated token baked into the scripts

### Example of using the output

This uses a plain `ubuntu:18.04` Docker container as the base environment 🙂:

    docker run -it --name repo2shellscript -p 8888:8888 \

        -v /home/test/repo2shellscript-output/r2dhttps-3a-2f-2fgithub-2ecom-2fbinder-2dexamples-2fconda5778653:/src:ro \

        ubuntu:18.04

    cd /src

    ./repo2shellscript-build.bash

    sudo -u  ./repo2shellscript-start.bash

### Systemd service:

If you use a Ubuntu:18.04 virtual machine your can use Systemd to start jupyter notebook:

    cp repo2shellscript.service /etc/systemd/system/

    systemctl daemon-reload

    systemctl start repo2shellscript

Connect to http://IP:8888.

You will need to enter the auto-generated `Jupyter token` from above.

If you have lost the output you can find the token in `repo2shellscript-start.bash` or `repo2shellscript.service`.

Alternatively set a fixed token in the configuration file.

### Building a vagrant image with Packer

Packer templates for building Virtualbox Vagrant (`repo2vagrant.pkr.hcl`) and Docker (`repo2docker.pkr.hcl`) images are included:

    cd repo2shellscript-output/r2dhttps-3a-2f-2fgithub-2ecom-2fbinder-2dexamples-2fconda5778653/

    packer build repo2vagrant.pkr.hcl

    packer build repo2docker.pkr.hcl

Note you must ensure the repo2docker `--user-name` and `--user-id` (also used as a group id) do not exist in the base image.

The [`ubuntu/bionic64`](https://app.vagrantup.com/ubuntu/boxes/bionic64) Vagrant box already contains group IDs `1000` and `1001` so you should set `--user-id` to `1002` or greater.

### Configuration file

For convenience you may wish to set a fixed token instead of the one randomly generated when the scripts are written.

Create a repo2docker configuration file, such as `repo2docker_config.py` with

```py

c.ShellScriptEngine.jupyter_token = 'secret123'

```

and run

    repo2docker --config repo2docker_config.py ...