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

doc: mention external stage1s #3723

Merged
merged 1 commit into from
Jul 10, 2017
Merged

doc: mention external stage1s #3723

merged 1 commit into from
Jul 10, 2017

Conversation

alban
Copy link
Member

@alban alban commented Jun 22, 2017

This was discussed on:
#3645 (comment)

/cc @lucab @euank @sstabellini @n0rad @iaguis @schu


Not sure it is the correct place to list the stage1s. Should it be a new file on the same model as https://github.com/rkt/rkt/blob/master/Documentation/production-users.md?

There are also out of tree stage1:
- [stage1-xen](https://github.com/rkt/stage1-xen), stage1 based on the Xen hypervisor
- [volo](https://github.com/lucab/rkt-volo), stage1 written in Rust, akin to stage1-fly
- [docker-skim](https://github.com/coreos/docker-skim), TODO: not clear to me what it is
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reference: this is a weaker version of stage1-fly, which gets rid of the chroot by bundling only some dependencies and then letting run inject LD_PRELOAD and other PATH-related tricks.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I updated the text.

@alban alban force-pushed the alban/stage1-doc branch from 866de01 to db12cf4 Compare June 22, 2017 13:03
There are also out of tree stage1:
- [stage1-xen](https://github.com/rkt/stage1-xen), stage1 based on the Xen hypervisor
- [volo](https://github.com/lucab/rkt-volo), stage1 written in Rust, akin to stage1-fly
- [docker-skim](https://github.com/coreos/docker-skim), a weaker version of stage1-fly using `LD_PRELOAD` tricks instead of chroot
Copy link
Member

@euank euank Jun 23, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be in favour of not including this one. I think it should remain largely unused, replaced entirely by torcx.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can keep it here if we want, this is developer docs and having links around comes handy when you are just looking for source references.

@sstabellini
Copy link

Thanks for the PR! It looks good from my point of view.

I wonder if it is also worth having a little paragraph outside "Documentation/devel" to point users, rather than developers, to out-of-tree stage1s. Something like Documentation/integrations.md, but that's obviously for projects that integrate rkt. This would be for optional features maintained externally. I don't know if there are any other components that could be listed there as "things that work with rkt".

@lucab
Copy link
Member

lucab commented Jun 26, 2017

I agree with Stefano. This IMHO ok to merge as is, but devdocs isn't meant for user consumption. We can probably add a running-stage1-xen.md like we have for fly and kvm, and then link them all from a short paragraph in README.

@lucab lucab added this to the 1.28.0 milestone Jun 26, 2017
Copy link
Member

@lucab lucab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sstabellini
Copy link

sstabellini commented Jun 26, 2017 via email

@lucab lucab merged commit 15127f0 into rkt:master Jul 10, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants