Skip to content

Commit

Permalink
Add end-user installation and usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
slonopotamus committed Sep 28, 2023
1 parent f70ac38 commit 598777e
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,23 @@ What rund provides:
* Host-network mode only
* bind mounts
== Prerequisites
== Installation and usage

See https://github.com/macOScontainers/homebrew-formula#readme[homebrew-formula] repository for end-user instructions.

== Development

This section describes development setup for hacking on rund code.

=== Prerequisites

* Disable https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection[System Integrity Protection].
SIP https://github.com/containerd/containerd/discussions/5525#discussioncomment-2685649[doesn't allow] to `chroot`.
* Install https://osxfuse.github.io[macFUSE] or https://www.fuse-t.org[fuse-t]
* Install https://bindfs.org/downloads/[bindfs] using https://github.com/mpartel/bindfs/issues/100#issuecomment-870699085[build instructions]

[[containerd]]
== Usage with containerd
=== Usage with containerd

Prerequisite: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry[authenticate to GitHub Package Registry].

Expand Down Expand Up @@ -59,7 +67,7 @@ sudo go run cmd/ctr/main.go run --rm -t --runtime "$(pwd)/../rund/bin/containerd

If you want to build image from scratch, see https://github.com/macOScontainers/macos-jail[macos-jail] project.

== Usage with BuildKit
=== Usage with BuildKit

Perform all the steps from <<containerd>>.

Expand Down Expand Up @@ -94,7 +102,7 @@ EOF
sudo go run ./cmd/buildctl build --frontend=dockerfile.v0 --local context=. -local dockerfile=.
----

== Usage with Docker
=== Usage with Docker

Perform all the steps from <<containerd>>.
You don't need BuildKit daemon to use Docker on macOS.
Expand Down

0 comments on commit 598777e

Please sign in to comment.