Skip to content

Commit 38b742e

Browse files
luxasluxas
committed
Initial commit
0 parents  commit 38b742e

23 files changed

+972
-0
lines changed

‎.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"go.formatTool": "goimports"
3+
}

‎Dockerfile

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
FROM golang:1.11 AS build
2+
WORKDIR /build
3+
ADD . .
4+
RUN make ignite
5+
6+
FROM alpine:latest
7+
RUN apk add --update iproute2
8+
ARG FIRECRACKER_VERSION=v0.15.2
9+
ADD https://github.com/firecracker-microvm/firecracker/releases/download/${FIRECRACKER_VERSION}/firecracker-${FIRECRACKER_VERSION} /firecracker
10+
# This Dockerfile's context is root of this repo
11+
COPY --from=build /build/bin/ignite /
12+
RUN chmod +x /firecracker /ignite
13+
RUN ln -s /firecracker /usr/local/bin/firecracker && ln -s /ignite /usr/local/bin/ignite

‎LICENSE

+175
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
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.

‎Makefile

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
all: build
2+
build:
3+
docker build -t ignite .
4+
5+
binary:
6+
docker run -it -v $(shell pwd):/build -w /build golang:1.12 make ignite
7+
8+
ignite: bin/ignite
9+
bin/ignite:
10+
CGO_ENABLED=0 go build -mod=vendor -o bin/ignite ./cmd/ignite

‎README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Firecracker Ignite
2+
3+
Lets you start a micro-VM with Firecracker easily.
4+
Integrates well with cloud-native projects like CNI, containerd and Docker.
5+
6+
### How to use
7+
8+
```console
9+
$ ignite build luxas/ubuntu:18.10 my-vm-image
10+
$ ignite images
11+
$ ignite start my-vm-image
12+
$ ignite attach my-vm-image
13+
$ ignite ps
14+
```
15+
16+
### Maintainers
17+
18+
Lucas Käldström, @luxas
19+
20+
### License
21+
22+
Apache 2.0

‎bin/ignite

5.01 MB
Binary file not shown.

‎cmd/ignite/cmd/build.go

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
package cmd
2+
3+
import (
4+
"io"
5+
6+
"github.com/luxas/ignite/pkg/errors"
7+
"github.com/spf13/cobra"
8+
)
9+
10+
// NewCmdBuild builds a Firecracker VM.
11+
func NewCmdBuild(out io.Writer) *cobra.Command {
12+
cmd := &cobra.Command{
13+
Use: "build",
14+
Short: "Build a Firecracker VM",
15+
Run: func(cmd *cobra.Command, args []string) {
16+
err := RunBuild(out, cmd)
17+
errors.Check(err)
18+
},
19+
}
20+
//cmd.Flags().StringP("output", "o", "", "Output format; available options are 'yaml', 'json' and 'short'")
21+
return cmd
22+
}
23+
24+
// RunBuild runs when the Build command is invoked
25+
func RunBuild(out io.Writer, cmd *cobra.Command) error {
26+
return nil
27+
}

‎cmd/ignite/cmd/exec.go

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
package cmd
2+
3+
import (
4+
"io"
5+
6+
"github.com/luxas/ignite/pkg/errors"
7+
"github.com/spf13/cobra"
8+
)
9+
10+
// NewCmdExec execs a command in a Firecracker VM.
11+
func NewCmdExec(out io.Writer) *cobra.Command {
12+
cmd := &cobra.Command{
13+
Use: "exec",
14+
Short: "Execute a command in a Firecracker VM",
15+
Run: func(cmd *cobra.Command, args []string) {
16+
err := RunExec(out, cmd)
17+
errors.Check(err)
18+
},
19+
}
20+
//cmd.Flags().StringP("output", "o", "", "Output format; available options are 'yaml', 'json' and 'short'")
21+
return cmd
22+
}
23+
24+
// RunExec runs when the Exec command is invoked
25+
func RunExec(out io.Writer, cmd *cobra.Command) error {
26+
return nil
27+
}

‎cmd/ignite/cmd/images.go

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
package cmd
2+
3+
import (
4+
"io"
5+
6+
"github.com/luxas/ignite/pkg/errors"
7+
"github.com/spf13/cobra"
8+
)
9+
10+
// NewCmdImages lists the images for your Firecracker VM.
11+
func NewCmdImages(out io.Writer) *cobra.Command {
12+
cmd := &cobra.Command{
13+
Use: "images",
14+
Short: "Imagesute a command in a Firecracker VM",
15+
Run: func(cmd *cobra.Command, args []string) {
16+
err := RunImages(out, cmd)
17+
errors.Check(err)
18+
},
19+
}
20+
//cmd.Flags().StringP("output", "o", "", "Output format; available options are 'yaml', 'json' and 'short'")
21+
return cmd
22+
}
23+
24+
// RunImages runs when the Images command is invoked
25+
func RunImages(out io.Writer, cmd *cobra.Command) error {
26+
return nil
27+
}

‎cmd/ignite/cmd/logs.go

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
package cmd
2+
3+
import (
4+
"io"
5+
6+
"github.com/luxas/ignite/pkg/errors"
7+
"github.com/spf13/cobra"
8+
)
9+
10+
// NewCmdLogs gets the logs for a Firecracker VM.
11+
func NewCmdLogs(out io.Writer) *cobra.Command {
12+
cmd := &cobra.Command{
13+
Use: "logs",
14+
Short: "Gets the logs for a Firecracker VM",
15+
Run: func(cmd *cobra.Command, args []string) {
16+
err := RunLogs(out, cmd)
17+
errors.Check(err)
18+
},
19+
}
20+
//cmd.Flags().StringP("output", "o", "", "Output format; available options are 'yaml', 'json' and 'short'")
21+
return cmd
22+
}
23+
24+
// RunLogs runs when the Logs command is invoked
25+
func RunLogs(out io.Writer, cmd *cobra.Command) error {
26+
return nil
27+
}

‎cmd/ignite/cmd/root.go

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
package cmd
2+
3+
import (
4+
"io"
5+
"os"
6+
7+
"github.com/lithammer/dedent"
8+
"github.com/spf13/cobra"
9+
)
10+
11+
// NewIgniteCommand returns cobra.Command to run kubeadm command
12+
func NewIgniteCommand(in io.Reader, out, err io.Writer) *cobra.Command {
13+
cmds := &cobra.Command{
14+
Use: "ignite",
15+
Short: "ignite: easily run Firecracker VMs",
16+
Long: dedent.Dedent(`
17+
Ignite helps you with foo, bar
18+
19+
Example usage:
20+
21+
$ ignite foo
22+
`),
23+
}
24+
25+
cmds.AddCommand(NewCmdBuild(os.Stdout))
26+
cmds.AddCommand(NewCmdExec(os.Stdout))
27+
cmds.AddCommand(NewCmdLogs(os.Stdout))
28+
cmds.AddCommand(NewCmdStart(os.Stdout))
29+
cmds.AddCommand(NewCmdStop(os.Stdout))
30+
cmds.AddCommand(NewCmdVersion(os.Stdout))
31+
return cmds
32+
}

0 commit comments

Comments
 (0)