mirror of
https://github.com/outbackdingo/matchbox.git
synced 2026-01-28 10:19:36 +00:00
67707d83a5
* Use Go 1.11 modules with `GO111MODULE=on` * Change `make vendor` target to call `go mod vendor` * Enforce builds and tests use the vendor directory by setting the `-mod=vendor` flag (notice, travis does not fetch) * Remove glide requirement and glide files
77 lines
1.7 KiB
Markdown
77 lines
1.7 KiB
Markdown
# Development
|
|
|
|
To develop `matchbox` locally, compile the binary and build the container image.
|
|
|
|
## Static binary
|
|
|
|
Build the static binary.
|
|
|
|
```sh
|
|
$ make build
|
|
```
|
|
|
|
Test with vendored dependencies.
|
|
|
|
```sh
|
|
$ make test
|
|
```
|
|
|
|
## Container image
|
|
|
|
Build a container image `coreos/matchbox:latest`.
|
|
|
|
```sh
|
|
$ make docker-image
|
|
```
|
|
|
|
## Version
|
|
|
|
```sh
|
|
$ ./bin/matchbox -version
|
|
$ sudo docker run coreos/matchbox:latest -version
|
|
```
|
|
## Run
|
|
|
|
Run the binary.
|
|
|
|
```sh
|
|
$ ./bin/matchbox -address=0.0.0.0:8080 -log-level=debug -data-path examples -assets-path examples/assets
|
|
```
|
|
|
|
Run the container image with rkt, on `metal0`.
|
|
|
|
```sh
|
|
$ sudo rkt --insecure-options=image run --net=metal0:IP=172.18.0.2 --mount volume=data,target=/var/lib/matchbox --volume data,kind=host,source=$PWD/examples --mount volume=config,target=/etc/matchbox --volume config,kind=host,source=$PWD/examples/etc/matchbox --mount volume=groups,target=/var/lib/matchbox/groups --volume groups,kind=host,source=$PWD/examples/groups/etcd matchbox.aci -- -address=0.0.0.0:8080 -rpc-address=0.0.0.0:8081 -log-level=debug
|
|
```
|
|
|
|
Alternately, run the Docker image on `docker0`.
|
|
|
|
```sh
|
|
$ sudo docker run -p 8080:8080 --rm -v $PWD/examples:/var/lib/matchbox:Z -v $PWD/examples/groups/etcd:/var/lib/matchbox/groups:Z coreos/matchbox:latest -address=0.0.0.0:8080 -log-level=debug
|
|
```
|
|
|
|
## bootcmd
|
|
|
|
Run `bootcmd` against the gRPC API of the service running via rkt.
|
|
|
|
```sh
|
|
$ ./bin/bootcmd profile list --endpoints 172.18.0.2:8081 --cacert examples/etc/matchbox/ca.crt
|
|
```
|
|
|
|
## Vendor
|
|
|
|
Add or update dependencies in `go.mod` and vendor.
|
|
|
|
```
|
|
make update
|
|
make vendor
|
|
```
|
|
|
|
## Codegen
|
|
|
|
Generate code from *proto* definitions using `protoc` and the `protoc-gen-go` plugin.
|
|
|
|
```sh
|
|
$ make codegen
|
|
```
|