aboutsummaryrefslogtreecommitdiff
path: root/docs/podman-derivative-api
blob: 1b6153df57e9f0db60a598c094398a674d4decc6 (plain)
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
.TH How to use libpod for custom/derivative projects
.PP
libpod today is a Golang library and a CLI.  The choice of interface you make has advantages and disadvantages.

.SH Running as a subprocess
.PP
Advantages:

.RS
.IP \(bu 2
Many commands output JSON
.IP \(bu 2
Works with languages other than Golang
.IP \(bu 2
Easy to get started

.RE

.PP
Disadvantages:

.RS
.IP \(bu 2
Error handling is harder
.IP \(bu 2
May be slower
.IP \(bu 2
Can't hook into or control low\-level things like how images are pulled

.RE

.SH Vendoring into a Go project
.PP
Advantages:

.RS
.IP \(bu 2
Significant power and control

.RE

.PP
Disadvantages:

.RS
.IP \(bu 2
You are now on the hook for container runtime security updates (partially, \fB\fCrunc\fR/\fB\fCcrun\fR are separate)
.IP \(bu 2
Binary size
.IP \(bu 2
Potential skew between multiple libpod versions operating on the same storage can cause problems

.RE

.SH Varlink
.PP
Some code exists for this; splits the difference.  Future uncertain.

.SH Making the choice
.PP
A good question to ask first is: Do you want users to be able to use \fB\fCpodman\fR to manipulate the containers created by your project?
If so, that makes it more likely that you want to run \fB\fCpodman\fR as a subprocess.  If you want a separate image store and a fundamentally
different experience; if what you're doing with containers is quite different from those created by the \fB\fCpodman\fR CLI,
that may drive you towards vendoring.