Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/4383/machine
Development environment container
https://github.com/4383/machine
Last synced: about 2 months ago
JSON representation
Development environment container
- Host: GitHub
- URL: https://github.com/4383/machine
- Owner: 4383
- License: gpl-3.0
- Created: 2016-11-15T12:21:49.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T14:02:01.000Z (11 months ago)
- Last Synced: 2024-11-11T23:37:51.737Z (3 months ago)
- Language: Shell
- Homepage: https://4383.github.io/machine/
- Size: 851 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# machine
Your development environment embedded in a docker container
[]()
[]()
## Features
- Assigned PID: python/tox process is automatically assigned PID `666`
No need to search your PID
- Running the docker image automatically launch preconfigured tmux with:
- list mounted directory
- show running process
- perf tools ready to run against PID `666`
- automatic monitoring context switch of PID `666`
- regexploit ready to run
- valgrind, pysnooper, py-spy, scalene run out of the box
- vim
- oh-my-zsh
## Disclaimers
Using this environment could generate various extra files into
the mounted repository. To avoid tracking these files accidentally,
you can create a global gitignore file that will be applied everywher
you are using `git`. These rules will be used in addition to the ones
provided in the repositories you works on.
First create a `~/.gitignore` file.
Once done, put these extra files patterns into this global gitignore file:
```
profiling.cprof
strace.txt
cmt_msg
.zsh_history
```
Then run this command `git config --global core.excludesFile '~/.gitignore'`.
## Usages
```shell
$ cd python
$ docker build -t machine-python312 .
$ # run the main instance of the dev container with a default dashboard
$ NAME=$(basename $(pwd))_py312; docker run -it --rm --name $NAME --mount type=bind,source="$(pwd)",target=/home/dev/app -e CONTAINER_NAME=$NAME --privileged machine-python312 /bin/bash
$ # run an other shell into this same container
$ docker exec -it dev_python_py312 /bin/bash
$ # stop all the instances of this container
$ docker stop dev_python_py312
```
Running the `docker run` command give you the following dashboard:
If you output things in files under `~/app`, then these files will remain
available even after the container shutdown. They will be reloaded at your next container restart.
You may want to trace or monitor things inside your container, so the
following command show you how enabling [eBPF](https://ebpf.io/) and
[BCC](https://github.com/iovisor/bcc) from mounting specific
volumes from your host:
```
NAME=$(basename $(pwd))_py312; docker run -it --rm --name $NAME --mount type=bind,source="$(pwd)",target=/home/dev/app -e CONTAINER_NAME=$NAME -v /lib/modules:/lib/modules:ro -v /usr/src:/usr/src:ro -v /etc/localtime:/etc/localtime:ro -v /usr/share/bcc/tools/:/usr/share/bcc/tools:ro --privileged machine-python312 /bin/bash
```
This container is built with BCC support. However, your host machine should
be also [setup to support BCC](https://github.com/iovisor/bcc/blob/master/INSTALL.md).
Once your container is running, you can launch eBPF BCC based tracing by
using commands like:
```
$ sudo /usr/share/bcc/tools/runqslower
```
Using `sudo` could be required.
## Demo
Here is a demo of how it works:
[](https://asciinema.org/a/0e7cLRsHiNJlBQdlIgdkApAsU)