File tree Expand file tree Collapse file tree 7 files changed +8
-445
lines changed Expand file tree Collapse file tree 7 files changed +8
-445
lines changed Original file line number Diff line number Diff line change 11
11
# express or implied. See the License for the specific language governing
12
12
# permissions and limitations under the License.
13
13
14
- SUBDIRS: =cmd/firectl
15
-
16
14
# Set this to pass additional commandline flags to the go compiler, e.g. "make test EXTRAGOARGS=-v"
17
15
EXTRAGOARGS: =
18
16
19
17
all : build
20
18
21
19
generate build clean test :
22
20
go $@ $(EXTRAGOARGS )
23
- for d in $( SUBDIRS) ; do \
24
- cd $$ d && go $@ $(EXTRAGOARGS ) ; \
25
- done
26
21
27
22
.PHONY : all generate clean build test
Original file line number Diff line number Diff line change 1
1
A basic Go interface to the Firecracker API
2
2
====
3
3
4
- This package is a Go library to interact with the Firecracker API. There is
5
- also a command-line application that can be used to control Firecracker microVMs
6
- called ` firectl ` .
4
+ This package is a Go library to interact with the Firecracker API. It
5
+ is designed as an abstraction of the OpenAPI-generated client that
6
+ allows for convenient manipulation of Firecracker VM from Go programs .
7
7
8
- There are some Firecracker features that are not yet supported by the SDK.
9
- These are tracked as GitHub issues with the
8
+ There are some Firecracker features that are not yet supported by the
9
+ SDK. These are tracked as GitHub issues with the
10
10
[ firecracker-feature] ( https://github.com/firecracker-microvm/firecracker-go-sdk/issues?q=is%3Aissue+is%3Aopen+label%3Afirecracker-feature )
11
11
label . Contributions to address missing features are welcomed.
12
12
@@ -25,8 +25,9 @@ additional flags to the Go compiler via the `EXTRAGOARGS` make variable.
25
25
Tools
26
26
---
27
27
28
- There's a [ firectl] ( cmd/firectl ) tool that provides a simple command-line
29
- interface to launching a firecracker VM.
28
+ There's a [ firectl] ( https://github.com/firecracker-microvm/firectl/ )
29
+ tool that provides a simple command-line interface to launching a
30
+ firecracker VM. It also serves as an example client of this SDK.
30
31
31
32
Network configuration
32
33
---
Load Diff This file was deleted.
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments