ooxi / mini-cross Goto Github PK

View Code? Open in Web Editor NEW

4.0 4.0 2.0 116 KB

Provides user configured development environments using docker

License: Other

Ruby 100.00%

mini-cross's Introduction

mini-cross

Provides user configured development environments.

Configuration

---
base: ubuntu:22.04	# ①
install:
 - nodejs		# ②
 - npm
publish:
 - 8080:80		# ③
 - 8443:443
---
#!/bin/bash

sudo npm install -g mini-cross	# ④

The configuration file contains two sections: first a YAML frontmatter section followed by an optional shell script. Splitting the configuration into a declarative and an imperative section enables describing common operations with minimal boilerplate while still allowing arbitary actions.

base describes the Docker image to be used as starting point for further setup.
install contains a list of packages to be installed from the distribution's package manager
publish contains a list of <host port>:<container port> declarations describing port forwarding from host to container
A shell script containing arbritrary commands to be executed while creating the container's image

Since mini-cross needs to know how to install packages on a certain distribution, not all Docker images are supported as base images. Current support includes:

CLI

There two ways of invoking mini-cross

The command invocation
The shell invocation

While technically similar, they provide for different use cases. The first allows to run individual commands inside the development environment while remaining attached to the host shell. The second changes the point of view to the inside of the development environment so that multiple commands can be executed while attached to the same container.

Therefore the command invocation is more suitable for scripted usage while the second is crafted toward comfort for interactive use.

Command invocation

mini-cross <options>* <machine> <command>*

When using mini-cross with command invocation, a machine has always to be specified. The machine determines where to look for the mini-cross configuration and allows for multiple configurations in the same project. The special machine _ is the default machine (most useful for shell invocation though).

This command will start the referenced machine and execute the command using the default docker entry point (most likely a bash shell).

When using mini-cross in a CI, it might be benefitial to pass --no-tty as option in order to not require a pty.

Shell invocation

mini-cross [<machine>]

Invoking mini-cross without additional commands is referred to as shell invocation because the development environment will stay attached to the current shell. Multiple commands may now be executed inside the same container, which can be quit using the exit command (assuming the container uses a shell like bash as docker entry point).

Since the shell invocation does not use arguments, the machine name can be omited and _ (the default machine) will be assumed.

mini-cross's People

Contributors

Stargazers

Watchers

Forkers

si-moon nicolube

mini-cross's Issues

Must ensure locale-gen is installed

While Ubuntu 16.04 ships locale-gen by default, at least Ubuntu 17.04 does not

Status: Downloaded newer image for ubuntu:17.04
 ---> e31f19d079cc
Step 2 : RUN locale-gen en_US.UTF-8
 ---> Running in 9daff42f4ca0
/bin/sh: 1: locale-gen: not found

                # @see https://github.com/moby/moby/issues/27988#issuecomment-600831315
                df.run_sh       "echo 'debconf debconf/frontend select Noninteractive' | sudo debconf-set-selections"

`parse_publication': `publication' must be of type `String' but `8080' is of type `Fixnum' (RuntimeError)

Sample yaml

---
base: ubuntu:16.04
install:
 - php-cli
publish:
 - 8080
---

Exception

src/yaml/publish-instruction.rb:60:in `parse_publication': `publication' must be of type `String' but `8080' is of type `Fixnum' (RuntimeError)

publish:
 - 1812:1812/udp

Support for includes

mini-cross configuration files should be able to include other configuration files.

Fix bundler deprecation warnings

[DEPRECATED] `Bundler.with_clean_env` has been deprecated in favor of `Bundler.with_unbundled_env`. If you instead want the environment before bundler was originally loaded, use `Bundler.with_original_env` (called at /mini-cross/dist/Rakefile:42)
[DEPRECATED] The `--path` flag is deprecated because it relies on being remembered across bundler invocations, which bundler will no longer do in future versions. Instead please use `bundle config set path '../vendor'`, and stop using this flag
[DEPRECATED] The `--without` flag is deprecated because it relies on being remembered across bundler invocations, which bundler will no longer do in future versions. Instead please use `bundle config set without 'development'`, and stop using this flag