mirror of
https://github.com/outbackdingo/matchbox.git
synced 2026-04-07 10:08:23 +00:00
219da4d934
* Add make targets for vendor, docker-image, and tools * Move scripts into the scripts folder
63 lines
1.8 KiB
Markdown
63 lines
1.8 KiB
Markdown
# Development
|
|
|
|
To develop `matchbox` locally, compile the binary and build the container image.
|
|
|
|
## Static Binary
|
|
|
|
Build the static binary.
|
|
|
|
make build
|
|
|
|
Test with vendored dependencies.
|
|
|
|
make test
|
|
|
|
## Container Image
|
|
|
|
Build an ACI `matchbox.aci`.
|
|
|
|
make aci
|
|
|
|
Alternately, build a Docker image `coreos/matchbox:latest`.
|
|
|
|
make docker-image
|
|
|
|
## Version
|
|
|
|
./bin/matchbox -version
|
|
sudo rkt --insecure-options=image run matchbox.aci -- -version
|
|
sudo docker run coreos/matchbox:latest -version
|
|
|
|
## Run
|
|
|
|
Run the binary.
|
|
|
|
./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`.
|
|
|
|
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`.
|
|
|
|
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.
|
|
|
|
./bin/bootcmd profile list --endpoints 172.18.0.2:8081 --cacert examples/etc/matchbox/ca.crt
|
|
|
|
## Vendor
|
|
|
|
Use `glide` and `glide-vc` to manage dependencies committed to the `vendor` directory.
|
|
|
|
make vendor
|
|
|
|
## Codegen
|
|
|
|
Generate code from *proto* definitions using `protoc` and the `protoc-gen-go` plugin.
|
|
|
|
make codegen
|
|
|