1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
[](https://linuxcontainers.org/)
# Go Bindings for LXC (Linux Containers)
LXC is the well-known and heavily tested low-level Linux container runtime. It
is in active development since 2008 and has proven itself in critical
production environments world-wide. Some of its core contributors are the same
people that helped to implement various well-known containerization features
inside the Linux kernel.
This package implements [Go](https://golang.org) bindings for the [LXC](https://linuxcontainers.org/lxc/introduction/) C API (liblxc).
## Status
Type | Service | Status
--- | --- | ---
CI (Linux) | Travis | [](https://travis-ci.org/lxc/go-lxc/)
Go documentation | Godoc | [](https://godoc.org/gopkg.in/lxc/go-lxc.v2)
Static analysis | GoReport | [](https://goreportcard.com/report/gopkg.in/lxc/go-lxc.v2)
## Requirements
This package requires [LXC >= 1.0.0](https://github.com/lxc/lxc/releases) and its development package and their dependencies to be installed. Additionally, go-lxc requires Golang 1.10 or later to work. Following command should install required dependencies on Ubuntu 18.10:
```bash
sudo apt update
sudo apt install git golang gcc make liblxc1 liblxc-dev lxc-utils pkg-config
```
## Installing
To install it, run:
```bash
go get gopkg.in/lxc/go-lxc.v2
```
## Trying
To try examples, run:
```bash
# cd ~/go/src/gopkg.in/lxc/go-lxc.v2/examples/
# make
==> Running go vet
==> Building ...
...
# create/create
2018/12/27 22:39:27 Creating container...
# start/start
2018/12/27 22:39:39 Starting the container...
2018/12/27 22:39:39 Waiting container to startup networking...
# attach/attach
2018/12/27 22:39:46 AttachShell
root@rubik:/# hostname
rubik
root@rubik:/# exit
exit
2018/12/27 22:39:52 RunCommand
uid=0(root) gid=0(root) groups=0(root)
# stop/stop
2018/12/27 22:39:54 Stopping the container...
# destroy/destroy
2018/12/27 22:39:57 Destroying container...
```
## Stability
The package API will remain stable as described in [gopkg.in](https://gopkg.in).
## Backwards Compatibility
LXC has always focused on strong backwards compatibility. In fact, the API hasn't been broken from release `1.0.0` onwards. Main LXC is currently at version `2.*.*`.
## Examples
See the [examples](https://github.com/lxc/go-lxc/tree/v2/examples) directory for some.
## Bug reports
Bug reports can be filed at: <https://github.com/lxc/go-lxc/issues/new>
## Contributing
Fixes and new features are greatly appreciated. We'd love to see go-lxc improve. To contribute to go-lxc;
* **Fork** the repository
* **Modify** your fork
* Ensure your fork **passes all tests**
* **Send** a pull request
* Bonus points if the pull request includes *what* you changed, *why* you changed it, and *tests* attached.
## Getting help
When you find you need help, the LXC projects provides you with several options.
### Discuss Forum
We maintain an discuss forum at
- https://discuss.linuxcontainers.org/
where you can get support.
### IRC
You can find support by joining `#lxcontainers` on `Freenode`.
### Mailing Lists
You can check out one of the two LXC mailing list archives and register if interested:
- http://lists.linuxcontainers.org/listinfo/lxc-devel
- http://lists.linuxcontainers.org/listinfo/lxc-users
|
