Minor README tweaks to help newbies
Signed-off-by: Doug Davis <dug@us.ibm.com>
This commit is contained in:
parent
d05943b95f
commit
1c81b08c8c
34
README.md
34
README.md
|
@ -5,15 +5,17 @@
|
||||||
### Building:
|
### Building:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
go get -d github.com/opencontainers/runc
|
# create a 'github.com/opencontainers' in your GOPATH
|
||||||
cd $GOPATH/src/github.com/opencontainers/runc/
|
cd github.com/opencontainers
|
||||||
|
git clone https://github.com/opencontainers/runc
|
||||||
|
cd runc
|
||||||
make
|
make
|
||||||
sudo make install
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
### Using:
|
### Using:
|
||||||
|
|
||||||
To run a container that you received just execute `runc run` with the JSON format at the argument or have a
|
To run a container that you received just execute `runc` with the JSON format as the argument or have a
|
||||||
`container.json` file in the current working directory.
|
`container.json` file in the current working directory.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -27,6 +29,10 @@ PID USER COMMAND
|
||||||
|
|
||||||
### OCF Container JSON Format:
|
### OCF Container JSON Format:
|
||||||
|
|
||||||
|
Below is a sample `container.json` configuration file. It assumes that
|
||||||
|
the file-system is found in a directory called `rootfs` and there is a
|
||||||
|
user named `daemon` defined within that file-system.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"version": "0.1",
|
"version": "0.1",
|
||||||
|
@ -126,6 +132,28 @@ PID USER COMMAND
|
||||||
|
|
||||||
### Examples:
|
### Examples:
|
||||||
|
|
||||||
|
#### Using a Docker image
|
||||||
|
|
||||||
|
To test using Docker's `busybox` image follow these steps:
|
||||||
|
* Install `docker` and download the `buysbox` image: `docker pull busybox`
|
||||||
|
* Create a container from that image and export its contents to a tar file:
|
||||||
|
`docker export $(docker create busybox) > busybox.tar`
|
||||||
|
* Untar the contents to create your filesystem directory:
|
||||||
|
```
|
||||||
|
mkdir rootfs
|
||||||
|
tar -C rootfs -xf busybox.tar
|
||||||
|
```
|
||||||
|
* Create a file called `container.json` using the example from above.
|
||||||
|
Modify the `user` property to be `root`.
|
||||||
|
* Execute `runc` and you should be placed into a shell where you can run `ps`:
|
||||||
|
```
|
||||||
|
$ runc
|
||||||
|
/ # ps
|
||||||
|
PID USER COMMAND
|
||||||
|
1 root sh
|
||||||
|
9 root ps
|
||||||
|
```
|
||||||
|
|
||||||
#### Using runc with systemd
|
#### Using runc with systemd
|
||||||
|
|
||||||
```service
|
```service
|
||||||
|
|
Loading…
Reference in New Issue