Skip to content

Commit f0d302c

Browse files
AkihiroSudaAkihiroSuda
committed
initial commit
Signed-off-by: Akihiro Suda <[email protected]>
0 parents  commit f0d302c

File tree

12 files changed

+1759
-0
lines changed

12 files changed

+1759
-0
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/nerdctl

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# nerdctl: Docker-compatible CLI for containerd
2+
3+
`nerdctl` is a Docker-compatible CLI for [containerd](https://containerd.io).
4+
5+
## Examples
6+
7+
To run a container with the default CNI network (10.4.0.0/16):
8+
```console
9+
# nerdctl run -it --rm alpine
10+
```
11+
12+
To build an image using BuildKit:
13+
```console
14+
# nerdctl build -t foo .
15+
# nerdctl run -it --rm foo
16+
```
17+
18+
To list Docker containers:
19+
```console
20+
# nerdctl --namespace moby ps -a
21+
```
22+
23+
To list Kubernetes containers:
24+
```console
25+
# nerdctl --namespace k8s.io ps -a
26+
```
27+
28+
## Install
29+
30+
```console
31+
# go get github.com/AkihiroSuda/nerdctl
32+
```
33+
34+
In addition to containerd, the following components should be installed (optional):
35+
- [CNI plugins](https://github.com/containernetworking/plugins): for internet connectivity.
36+
- [BuildKit](https://github.com/moby/buildkit): for using `nerdctl build`. BuildKit daemon (`buildkitd`) needs to be running.
37+
38+
## Motivation
39+
40+
The goal of `nerdctl` is to facilitate experimenting the cutting-edge features of containerd that are not present in Docker.
41+
42+
Such features includes, but not limited to, [lazy-pulling](https://github.com/containerd/stargz-snapshotter) and [encryption of images](https://github.com/containerd/imgcrypt).
43+
44+
Also, `nerdctl` might be potentially useful for debugging Kubernetes clusters, but it is not the primary goal.
45+
46+
## Similar tools
47+
48+
- `ctr`: incompatible with Docker, and not friendly to users
49+
- [`crictl`](https://github.com/kubernetes-sigs/cri-tools): incompatible with Docker, not friendly to users, and does not support non-CRI features
50+
- [k3c](https://github.com/rancher/k3c): needs an extra daemon, and does not support non-CRI features
51+
- [PouchContainer](https://github.com/alibaba/pouch): needs an extra daemon
52+
53+
## Implementation status of Docker-compatible commands and flags
54+
55+
- `nerdctl build`
56+
- `-t`
57+
58+
- `nerdctl ps`
59+
- `-a` (WIP: Ignored and always assumed to be true)
60+
- `--no-trunc`
61+
62+
- `nerdctl pull`
63+
64+
- `nerdctl run`
65+
- `-i` (WIP: always needs to be true)
66+
- `-t` (WIP: always needs to be true)
67+
- `--rm`
68+
- `--network=(bridge|host|none)`
69+
- `--dns`
70+
- `--pull=(always|missing|never)`
71+
72+
Lots of commands and flags are currently missing. Pull requests are highly welcome.
73+
74+
## Contributing to nerdctl
75+
76+
- Please certify your [Developer Certificate of Origin (DCO)](https://developercertificate.org/), by signing off your commit with `git commit -s` and with your real name.

‎build.go‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
/*
2+
Copyright (C) nerdctl authors.
3+
Copyright (C) containerd authors.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
*/
17+
18+
package main
19+
20+
import (
21+
"errors"
22+
"os"
23+
"os/exec"
24+
"strings"
25+
26+
"github.com/containerd/containerd"
27+
"github.com/urfave/cli/v2"
28+
)
29+
30+
var buildCommand = &cli.Command{
31+
Name: "build",
32+
Usage: "Build an image from a Dockerfile. Needs buildkitd to be running.",
33+
Action: buildAction,
34+
Flags: []cli.Flag{
35+
&cli.StringFlag{
36+
Name: "tag",
37+
Aliases: []string{"t"},
38+
Usage: "Name and optionally a tag in the 'name:tag' format",
39+
},
40+
},
41+
}
42+
43+
func buildAction(clicontext *cli.Context) error {
44+
if clicontext.NArg() < 1 {
45+
return errors.New("context needs to be specified")
46+
}
47+
buildContext := clicontext.Args().First()
48+
tag := clicontext.String("tag")
49+
if tag == "" {
50+
return errors.New("tag needs to be specified")
51+
}
52+
sn := containerd.DefaultSnapshotter
53+
containerdAddr := strings.TrimPrefix(clicontext.String("host"), "unix://")
54+
ns := clicontext.String("namespace")
55+
56+
buildctlCmd := exec.Command("buildctl",
57+
"build",
58+
"--frontend=dockerfile.v0",
59+
"--local=context="+buildContext,
60+
"--local=dockerfile="+buildContext,
61+
"--output=type=docker,name="+tag)
62+
buildctlCmd.Env = os.Environ()
63+
64+
// FIXME: do not rely on ctr command
65+
ctrCmd := exec.Command("ctr",
66+
"--address", containerdAddr,
67+
"--namespace", ns,
68+
"images",
69+
"import",
70+
"--snapshotter", sn,
71+
"-")
72+
ctrCmd.Env = os.Environ()
73+
74+
buildctlStdout, err := buildctlCmd.StdoutPipe()
75+
if err != nil {
76+
return err
77+
}
78+
buildctlCmd.Stderr = clicontext.App.Writer
79+
ctrCmd.Stdin = buildctlStdout
80+
ctrCmd.Stdout = clicontext.App.Writer
81+
ctrCmd.Stderr = clicontext.App.ErrWriter
82+
83+
if err := buildctlCmd.Start(); err != nil {
84+
return err
85+
}
86+
if err := ctrCmd.Start(); err != nil {
87+
return err
88+
}
89+
return ctrCmd.Wait()
90+
}

0 commit comments

Comments
 (0)