Skip to content

Commit

Permalink
feat: rename RustyHermit to Hermit
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Kröning <martin.kroening@eonerc.rwth-aachen.de>
  • Loading branch information
mkroening committed Aug 26, 2023
1 parent 17eae62 commit 5251cd3
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 28 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<img width="100" align="right" src="img/hermitcore_logo.png" />

# RustyHermit - A Rust-based, lightweight unikernel
# Hermit for Rust - A Rust-based, lightweight unikernel

[![Zulip Badge](https://img.shields.io/badge/chat-hermit-57A37C?logo=zulip)](https://hermit.zulipchat.com/)

[RustyHermit](http://www.hermitcore.org) is a [unikernel](http://unikernel.org) targeting a scalable and predictable runtime for high-performance and cloud computing.
[Hermit](http://www.hermitcore.org) is a [unikernel](http://unikernel.org) targeting a scalable and predictable runtime for high-performance and cloud computing.
Unikernel means, you bundle your application directly with the kernel library, so that it can run without any installed operating system.
This reduces overhead, therefore, interesting applications include virtual machines and high-performance computing.

The kernel is able to run [Rust](https://github.com/hermitcore/rusty-hermit) applications, as well as [C/C++/Go/Fortran](https://github.com/hermitcore/hermit-playground) applications.
The kernel is able to run [Rust](https://github.com/hermitcore/hermit-rs) applications, as well as [C/C++/Go/Fortran](https://github.com/hermitcore/hermit-playground) applications.

The repository contains following directories and submodules:

Expand All @@ -20,15 +20,15 @@ The repository contains following directories and submodules:

## Background

**RustyHermit** is a rewrite of HermitCore in [Rust](https://www.rust-lang.org) developed at [RWTH-Aachen](https://www.rwth-aachen.de).
**Hermit** is a rewrite of HermitCore in [Rust](https://www.rust-lang.org) developed at [RWTH-Aachen](https://www.rwth-aachen.de).
HermitCore was a research unikernel written in C ([libhermit](https://github.com/hermitcore/libhermit)).

The ownership model of Rust guarantees memory/thread-safety and enables us to eliminate many classes of bugs at compile-time.
Consequently, the use of Rust for kernel development promises fewer vulnerabilities in comparison to common programming languages.

The kernel and the integration into the Rust runtime are entirely written in Rust and do not use any C/C++ Code.
We extended the Rust toolchain so that the build process is similar to Rust's usual workflow.
Rust applications that use the Rust runtime and do not directly use OS services are able to run on RustyHermit without modifications.
Rust applications that use the Rust runtime and do not directly use OS services are able to run on Hermit without modifications.

## Requirements

Expand All @@ -40,7 +40,7 @@ Rust applications that use the Rust runtime and do not directly use OS services
Have a look at [rusty-demo](https://github.com/hermitcore/rusty-demo).


## Use RustyHermit for C/C++, Go, and Fortran applications
## Use Hermit for C/C++, Go, and Fortran applications

If you are interested to build C/C++, Go, and Fortran applications on top of a Rust-based library operating system, please take a look at [https://github.com/hermitcore/hermit-playground](https://github.com/hermitcore/hermit-playground).

Expand All @@ -52,11 +52,11 @@ If you are interested to build C/C++, Go, and Fortran applications on top of a R

## Wiki

Please use the [Wiki](https://github.com/hermitcore/rusty-hermit/wiki) to get further information and configuration options.
Please use the [Wiki](https://github.com/hermitcore/hermit-rs/wiki) to get further information and configuration options.

## Credits

RustyHermit is derived from following tutorials and software distributions:
Hermit is derived from following tutorials and software distributions:

1. Philipp Oppermann's [excellent series of blog posts][opp].
2. Erik Kidd's [toyos-rs][kidd], which is an extension of Philipp Opermann's kernel.
Expand All @@ -81,12 +81,12 @@ at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

RustyHermit is being developed on [GitHub](https://github.com/hermitcore/rusty-hermit).
Hermit is being developed on [GitHub](https://github.com/hermitcore/hermit-rs).
Create your own fork, send us a pull request, and chat with us on [Zulip](https://hermit.zulipchat.com/).

## Publications

The following scientific publications are related to RustyHermit:
The following scientific publications are related to Hermit:

- S. Lankes et al. - [Exploring Rust for Unikernel Development](https://dl.acm.org/doi/10.1145/3365137.3365395)
- M. Sung et al. - [Intra-unikernel isolation with Intel memory protection keys](https://dl.acm.org/doi/10.1145/3381052.3381326)
Expand Down
2 changes: 1 addition & 1 deletion benches/alloc/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ SOFTWARE.
/* Heavily modified by Shaun Beautement. All errors are probably my own. */

/*
* This benchmark was revised for RustyHermit by Stefan Lankes.
* This benchmark was revised for Hermit by Stefan Lankes.
* The original code is part of the crate `talc`.
*/

Expand Down
2 changes: 1 addition & 1 deletion benches/netbench/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This repo contains programs to benchmark how much bandwidth we effectively have available on a communication channel and what's the latency on that channel.

It is froked from [rust-tcp-io-perf](https://github.com/LorenzoMartini/rust-tcp-io-perf) and used to measure the network performance of RustyHermit.
It is froked from [rust-tcp-io-perf](https://github.com/LorenzoMartini/rust-tcp-io-perf) and used to measure the network performance of Hermit.

## Bandwidth measure

Expand Down
4 changes: 2 additions & 2 deletions examples/httpd/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ fn main() {

let now = time::OffsetDateTime::now_utc();
let text = format!(
"Hello from RustyHermit {}!\nThe current UTC time is {}!\n",
"Hello from Hermit {}!\nThe current UTC time is {}!\n",
String::from_utf8(crab.clone()).unwrap_or_default(),
now
);
Expand All @@ -41,7 +41,7 @@ fn main() {

let now = time::OffsetDateTime::now_utc();
let text = format!(
"Hello from RustyHermit {}!\nThe current UTC time is {}!\n",
"Hello from Hermit {}!\nThe current UTC time is {}!\n",
String::from_utf8(crab.clone()).unwrap_or_default(),
now
);
Expand Down
2 changes: 1 addition & 1 deletion hermit-abi/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ authors = ["Stefan Lankes"]
license = "MIT OR Apache-2.0"
edition = "2021"
description = "Hermit system calls definitions."
repository = "https://github.com/hermitcore/rusty-hermit"
repository = "https://github.com/hermitcore/hermit-rs"
keywords = ["unikernel", "libos"]
categories = ["os"]

Expand Down
6 changes: 3 additions & 3 deletions hermit-abi/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# hermit-abi

[![Crates.io](https://img.shields.io/crates/v/hermit-abi.svg)](https://crates.io/crates/hermit-abi)
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://hermitcore.github.io/rusty-hermit/hermit_abi/)
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://hermitcore.github.io/hermit-rs/hermit_abi/)
[![License](https://img.shields.io/crates/l/hermit-abi.svg)](https://img.shields.io/crates/l/hermit-abi.svg)

This is small interface to call functions from the unikernel [RustyHermit](https://github.com/hermitcore/kernel).
This is small interface to call functions from the [Hermit kernel](https://github.com/hermitcore/kernel).

Please read the README of [RustyHermit](https://github.com/hermitcore/kernel) for more information.
Please read the README of the [Hermit kernel](https://github.com/hermitcore/kernel) for more information.

## License

Expand Down
4 changes: 2 additions & 2 deletions hermit-abi/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! `hermit-abi` is small interface to call functions from the unikernel
//! [RustyHermit](https://github.com/hermitcore/kernel).
//! `hermit-abi` is small interface to call functions from the
//! [Hermit unikernel](https://github.com/hermitcore/kernel).

#![no_std]
#![allow(nonstandard_style)]
Expand Down
2 changes: 1 addition & 1 deletion hermit/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = "0.5.3"
authors = ["Stefan Lankes"]
license = "MIT OR Apache-2.0"
description = "FFI bindings to HermitCore"
repository = "https://github.com/hermitcore/rusty-hermit"
repository = "https://github.com/hermitcore/hermit-rs"
keywords = ["unikernel", "libos"]
categories = ["os"]
links = "hermit"
Expand Down
6 changes: 3 additions & 3 deletions hermit/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# hermit

[![Crates.io](https://img.shields.io/crates/v/hermit.svg)](https://crates.io/crates/hermit)
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://hermitcore.github.io/rusty-hermit/hermit/)
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://hermitcore.github.io/hermit-rs/hermit/)
[![License](https://img.shields.io/crates/l/hermit.svg)](https://img.shields.io/crates/l/hermit.svg)

This is a container for the library operating system [RustyHermit](https://github.com/hermitcore/kernel) and is used to link the libos to the application.
This is a container for the [Hermit kernel](https://github.com/hermitcore/kernel) and is used to link the libos to the application.

Please read the README of [RustyHermit](https://github.com/hermitcore/kernel) for more information.
Please read the README of the [Hermit kernel](https://github.com/hermitcore/kernel) for more information.

## License

Expand Down
8 changes: 4 additions & 4 deletions k8s/httpd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ spec:
volumes:
- name: containerdisk
containerDisk:
image: registry.git.rwth-aachen.de/acs/public/hermitcore/rusty-hermit/httpd:latest
image: registry.git.rwth-aachen.de/acs/public/hermitcore/hermit-rs/httpd:latest
---
kind: Service
apiVersion: v1
Expand Down Expand Up @@ -72,10 +72,10 @@ metadata:
spec:
tls:
- hosts:
- rusty-hermit.k8s.eonerc.rwth-aachen.de
secretName: letsencrypt-prod-rusty-hermit
- hermit-rs.k8s.eonerc.rwth-aachen.de
secretName: letsencrypt-prod-hermit-rs
rules:
- host: rusty-hermit.k8s.eonerc.rwth-aachen.de
- host: hermit-rs.k8s.eonerc.rwth-aachen.de
http:
paths:
- backend:
Expand Down

0 comments on commit 5251cd3

Please sign in to comment.