Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aditya1404sal/nonhypervisor
A Parody of a widely known Containerisation tool
https://github.com/aditya1404sal/nonhypervisor
Last synced: about 1 month ago
JSON representation
A Parody of a widely known Containerisation tool
- Host: GitHub
- URL: https://github.com/aditya1404sal/nonhypervisor
- Owner: Aditya1404Sal
- License: apache-2.0
- Created: 2024-06-30T18:50:41.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-10T09:44:40.000Z (6 months ago)
- Last Synced: 2024-07-10T21:49:32.528Z (6 months ago)
- Language: Go
- Homepage:
- Size: 3.28 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NonHypervisor : A Mock Containerization Engine
This project is a basic implementation of a mock containerization engine designed to help understand the fundamentals of containerization and how Docker works. It is intended as an educational tool and should be used with individual discretion.
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Configuration](#configuration)
- [Setup](#setup)
- [Usage](#usage)
- [Example](#example)
- [Limitations](#limitations)
- [Acknowledgements](#acknowledgements)
## Overview
This project simulates the behavior of containerization by isolating processes using Linux namespaces, setting up root filesystems, environment variables, and networking. It serves as a parody of Docker and demonstrates how container environments can be created and managed.
## Features
- Namespace isolation (PID, UTS, mount, network)
- Root filesystem setup using images from a container registry
- Environment variable configuration
- Command execution within the container
- Networking setup with virtual Ethernet pairs and port forwarding
## Configuration
Configuration for the container setup is provided via a text file (`config.txt` by default). The configuration file supports the following directives:
- `FROM `: Specifies the base image to use for the root filesystem.
- `ENV =`: Sets environment variables inside the container.
- `RUN `: Runs a command during the container setup.
- `CMD `: Specifies the command to run inside the container.
- `EXPOSE `: Exposes a port from the container.
## Setup
### Prerequisites
- Go (Golang) installed on your system.
- Basic knowledge of Linux commands and networking.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/mock-containerization-engine.git
cd mock-containerization-engine
```
2. Install dependencies:
```bash
go mod tidy
```
## Usage
### Running the Mock Container Engine
1. Create a configuration file (`config.txt`) with the desired container setup.
2. Run the mock container engine:
```bash
go run main.go config.txt
```
### Configuration File Format
Here is an example `config.txt`:
```txt
FROM ubuntu:latest
ENV PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
RUN apt-get update
RUN apt-get install -y curl
CMD ["/bin/bash"]
EXPOSE 8080
```
## Example
1. Create a configuration file named `config.txt`:
```txt
FROM ubuntu:latest
ENV PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
RUN apt-get update
RUN apt-get install -y curl
CMD ["/bin/bash"]
EXPOSE 8080
```
2. Run the mock container engine:
```bash
go run main.go config.txt
```
## Limitations
- This project is a simplified and educational tool, not suitable for production use.
- Lacks advanced features and robustness of real container engines like Docker.
- Networking setup is basic and may not cover all use cases.
- Error handling is minimal and may need improvement for real-world applications.
## Acknowledgements
This project uses the following libraries:
- [go-containerregistry](https://github.com/google/go-containerregistry) by Google
- Various Go standard libraries
## Disclaimer
This project is a parody and should be used with individual discretion. It is designed for educational purposes to help understand containerization concepts and is not intended for production use.
---
Feel free to explore, learn, and modify the code to suit your educational needs. Happy containerizing!