Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix documentation #46

Merged
merged 1 commit into from
Apr 1, 2021
Merged

Fix documentation #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Hook is the Tinkerbell Installation Environment for bare-metal. It runs in-memor

One of the [Tinkerbell](https://tinkerbell.org) components is the operating
system installation environment. Currently, Tinkerbell uses
[OSIE](https:github.com/tinkebell/osie). That implementation is open-sourced by
[OSIE](https://github.com/tinkebell/osie). That implementation is open-sourced by
Equinix Metal and it is serving the purpose of provisioning and de-provisioning
hardware at a huge scale. But why we started this project?

Expand Down Expand Up @@ -39,7 +39,7 @@ The hook project aims to provide an "in-place" swappable set of files (`kernel`/
- Lean / simple design
- Clean base to build upon

The hook project predominantly uses [linuxkit](github.com/linuxkit/linuxkit) as the toolkit that will produce repeatable and straightforward build of the entire in-memory operating system. The linuxkit project combines a Linux kernel with a number of additional container images to produce a Linux Operating System with just the right amount of functionality (no less / no more). We have built upon the minimal set of components:
The hook project predominantly uses [linuxkit](https://github.com/linuxkit/linuxkit) as the toolkit that will produce repeatable and straightforward build of the entire in-memory operating system. The linuxkit project combines a Linux kernel with a number of additional container images to produce a Linux Operating System with just the right amount of functionality (no less / no more). We have built upon the minimal set of components:

- containerd (the engine to start/stop all other components in a LinuxKit OS)
- dhcp (for network access)
Expand Down Expand Up @@ -81,19 +81,14 @@ it with the release package containing the new operating system. After you have
removed the directory, it is time to re-create it:

```
mkdir current
```

Download the new tar.gz
# check out this repo
git clone https://github.com/tinkerbell/hook.git

```
wget http://s.gianarb.it/hook/hook-master.tar.gz
```

Uncompress it
# build it - this produces a hook-<commit SHA>.tar.gz
make dist

```
tar xzcv -O ./current hook-master.tar.gz
# copy the output to current (the filename will be different)
tar -xf hook-bc3e58a-dirty.tar.gz -C ../sandbox/deploy/state/webroot/misc/osie/current/
```

Now you are ready to boot the worker, it will pick up the new operating system
Expand Down