Skip to content
This repository has been archived by the owner on Jun 1, 2020. It is now read-only.

honnix/rkt-launcher

Repository files navigation

rkt-launcher

CircleCI Coverage Status Maven Central License

To launch rkt in a type-safe way using Java (a.k.a rkt Java API).

rkt is designed to be used as a command line executable without having a daemon. To understand the design philosophy, you are encouraged to read this document.

rkt-launcher starts with a core lib that can be used to fork rkt process in a type-safe way; then it provides a service exposing RESTful APIs through which the user can interact with rkt remotely; and last but not least, a client is shipped to ease the process talking to the service.

This project is in beta stage. Most of the features have been implemented and can be used for production. Backward compatibility will be ensured on a best efforts basis.

Usage

Prerequisite

  • rkt has been installed, check here for details
  • JDK8 has been installed
  • Maven has been installed

To build

$ git clone [email protected]:honnix/rkt-launcher.git
$ mvn package

To start the service:

$ java -jar rkt-launcher-service/target/rkt-launcher-service.jar -Dhttp.server.port=8080

To start hacking

Import the maven project to your favorite IDE or choose whatever editor you like. Well, it's just plain Java.

rkt-launcher-common

This module contains options passed to rkt, models capturing rkt output and a few utilities handling JSON, time, etc.

Read More

rkt-launcher-core

Core library to fork rkt process and handle output.

Read More

rkt-launcher-service

This module exposes RESTful APIs to fork rkt process and handle output.

This service is built using Apollo framework.

Read More

rkt-launcher-remote

Talking to rkt-launcher-service remotely.

Read More