jasder
/
runc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fix README.md for nsinit 

Cut the long lines and add `--config` to the `nsinit exec` command.
And some grammar fix.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
This commit is contained in:
Qiang Huang 2015-04-01 13:50:48 +08:00
parent c851275416
commit c06f92353f
1 changed files with 29 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
nsinit/README.md
View File

@ -5,13 +5,15 @@ It is able to spawn new containers or join existing containers.
### How to build? ### How to build?
First to add the `libcontainer/vendor` into your GOPATH. It's because something related with this [issue](https://github.com/docker/libcontainer/issues/210). First add the `libcontainer/vendor` into your GOPATH. It's because libcontainer
vendors all its dependencies, so it can be built predictably.
``` ```
export GOPATH=$GOPATH:/your/path/to/libcontainer/vendor export GOPATH=$GOPATH:/your/path/to/libcontainer/vendor
``` ```
Then get into the nsinit folder and get the imported file. Use `make` command to make the nsinit binary. Then get into the nsinit folder and get the imported file. Use `make` command
to make the nsinit binary.
``` ```
cd libcontainer/nsinit cd libcontainer/nsinit
@ -19,7 +21,8 @@ go get
make make
``` ```
We have finished compiling the nsinit package, but a root filesystem must be provided for use along with a container configuration file. We have finished compiling the nsinit package, but a root filesystem must be
provided for use along with a container configuration file.
Choose a proper place to run your container. For example we use `/busybox`. Choose a proper place to run your container. For example we use `/busybox`.
@ -28,30 +31,37 @@ mkdir /busybox
curl -sSL 'https://github.com/jpetazzo/docker-busybox/raw/buildroot-2014.11/rootfs.tar' | tar -xC /busybox curl -sSL 'https://github.com/jpetazzo/docker-busybox/raw/buildroot-2014.11/rootfs.tar' | tar -xC /busybox
``` ```
Then you may need to write a configure file named `container.json` in the `/busybox` folder. Then you may need to write a configuration file named `container.json` in the
Environment, networking, and different capabilities for the container are specified in this file. `/busybox` folder. Environment, networking, and different capabilities for
The configuration is used for each process executed inside the container the container are specified in this file. The configuration is used for each
See the `sample_configs` folder for examples of what the container configuration should look like. process executed inside the container.
See the `sample_configs` folder for examples of what the container configuration
should look like.
``` ```
cp libcontainer/sample_configs/minimal.json /busybox/container.json cp libcontainer/sample_configs/minimal.json /busybox/container.json
cd /busybox cd /busybox
``` ```
Now the nsinit is ready to work. You can customize `container.json` per your needs. After that, nsinit is
To execute `/bin/bash` in the current directory as a container just run the following **as root**: ready to work.
To execute `/bin/bash` in the current directory as a container just run the
following **as root**:
```bash ```bash
nsinit exec --tty /bin/bash nsinit exec --tty --config container.json /bin/bash
``` ```
If you wish to spawn another process inside the container while your If you wish to spawn another process inside the container while your current
current bash session is running, run the same command again to bash session is running, run the same command again to get another bash shell
get another bash shell (or change the command). If the original (or change the command). If the original process (PID 1) dies, all other
process (PID 1) dies, all other processes spawned inside the container processes spawned inside the container will be killed and the namespace will
will be killed and the namespace will be removed. be removed.
You can identify if a process is running in a container by You can identify if a process is running in a container by looking to see if
looking to see if `state.json` is in the root of the directory. `state.json` is in the root of the directory.
You may also specify an alternate root place where You may also specify an alternate root directory from where the `container.json`
the `container.json` file is read and where the `state.json` file will be saved. file is read and where the `state.json` file will be saved.