Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coditva/bunker

Clone of Docker containerization engine built on containerd runtime
https://github.com/coditva/bunker

clone containerd containers go golang oci

Last synced: about 11 hours ago
JSON representation

Clone of Docker containerization engine built on containerd runtime

Host: GitHub
URL: https://github.com/coditva/bunker
Owner: coditva
License: mit
Created: 2019-03-04T20:58:56.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-02-24T18:33:19.000Z (over 1 year ago)
Last Synced: 2024-06-21T18:38:57.612Z (5 months ago)
Topics: clone, containerd, containers, go, golang, oci
Language: Go
Homepage: https://coditva.github.io/bunker/
Size: 230 KB
Stars: 1
Watchers: 4
Forks: 2
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Build Status](https://img.shields.io/travis/com/coditva/bunker.svg?logo=travis&style=for-the-badge)](https://travis-ci.com/coditva/bunker)

[![Libraries.io dependency status](https://img.shields.io/librariesio/github/coditva/bunker.svg?style=for-the-badge)](https://libraries.io/github/coditva/bunker)

[![Golang version](https://img.shields.io/badge/Golang-1.12-lightgrey.svg?style=for-the-badge)](https://golang.org/project)

[![GoDoc](https://img.shields.io/badge/GoDoc-Reference-blue.svg?style=for-the-badge)](https://godoc.org/github.com/coditva/bunker/internal)

[![GitHub issues](https://img.shields.io/github/issues/coditva/bunker.svg?logo=github&style=for-the-badge)](https://github.com/coditva/bunker/issues)

[![GitHub pull requests](https://img.shields.io/github/issues-pr/coditva/bunker.svg?logo=github&style=for-the-badge)](https://github.com/coditva/bunker/pulls)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/coditva/bunker.svg?style=for-the-badge)

[![License](https://img.shields.io/github/license/coditva/bunker.svg?color=blue&style=for-the-badge)](https://github.com/coditva/bunker/blob/master/LICENSE)

# Bunker

_Small clone of the Docker containerization engine_

## About

The project is divided into two binaries:

### `bunkerd`

This is the daemon which controls the

[containerd](https://github.com/containerd/containerd) running in the background

as the back-end. It exposes an API accessible via containerd client over the

socket mentioned in the `internal/config.go` file. The API could be found in the

`internal/` folder.  It is similar to the Docker API but is more minimal.

### `bunker`

This is the CLI for the bunker daemon. It parses user commands and sends them to

the containerd daemon.

## Building the project

To build both the binaries, simply issue the `make` command in the project root.

```bash

make    # build the binaries

```

To build the binaries selectively, you can specify the binary name as the target

to the make file.

```bash

make bunker     # build bunker cli

make bunkerd    # build bunker daemon

```

You can even use the build script in the `scripts/build` directory.

```bash

export TARGET=bunker

sh scripts/build/binary.sh

```

## Using Bunker

### Using `bunkerd` daemon

To start the bunkerd daemon, simply issue the following command (you will need

`sudo` rights):

```bash

sudo build/bunkerd start    # start the daemon

sudo build/bunkerd stop     # stop the daemon

```

### Using the `bunker` CLI

Use the binary in `build/` to run the CLI:

```bash

sudo build/bunker pull [image]      # pull an image

```

## API

The Bunker CLI is very similar to the most popular containerization engine

Docker, but is more minimal than that. The project is in its early stages and

at present the following commands are implemented in `bunker`:

- `pull`: Pull an image from the docker registry

- `images`: List images pulled from the registry

- `run`: Create and start a container

- `containers`: List the containers

- `rm`: Remove containers

## Debugging

The log files for the daemon and CLI found in `/tmp` as `/tmp/bunkerd.log` and

`/tmp/bunker.log` respectively can be used to debug errors or track execution.

## License

MIT (c) 2019-present Utkarsh Maheshwari 

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcoditva%2Fbunker.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcoditva%2Fbunker?ref=badge_large)