README
¶
Inventory management system for patchwork assets.
API specification
prerequisites
To build and deploy the server:
-
docker
-
docker-compose
To build the client:
- go
procedure
Deploy haul database and server
$ docker-compose up -d --build
Make sure the server is up
$ docker-compose logs haul
optional - local cli
Haul is accessed mainly through its API.
Install the cli locally.
$ go install
Then, add a config locally to $HOME/.haul.yaml (based on the Config struct in ./models/config.go), or specify a different config location with the --config flag.
Note that if you installed the server from docker-compose without any modifications (not suited for production), you should only need to set client.api.host
Once that is done, make sure you can access the server with a healthcheck
$ haul ping
Alternatively, you can query GET /v1/health http/1.1 (requires key authentication by default, which is silly)
See $ haul help for more options
Documentation
¶
Overview ¶
Copyright © 2023 The Haul Authors
Inventory management system for patchwork assets.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides an API client sdk for making requests to a haul API server
|
Package api provides an API client sdk for making requests to a haul API server |
|
Package cli provides a client SDK for outputting data to a terminal in multiple formats
|
Package cli provides a client SDK for outputting data to a terminal in multiple formats |
|
Package cmd implements cli (cobra/viper) commands for the application.
|
Package cmd implements cli (cobra/viper) commands for the application. |
|
asset
Package assetcmd provides commands for manipulating assets
|
Package assetcmd provides commands for manipulating assets |
|
asset/description
Package assetdescriptioncmd provides commands for manipulating asset descriptions
|
Package assetdescriptioncmd provides commands for manipulating asset descriptions |
|
asset/status
Package assetstatuscmd provides commands for manipulating asset status
|
Package assetstatuscmd provides commands for manipulating asset status |
|
asset/target
Package assettargetcmd provides commands for manipulating asset targets
|
Package assettargetcmd provides commands for manipulating asset targets |
|
event
Package eventcmd provides commands for manipulating events
|
Package eventcmd provides commands for manipulating events |
|
Package db provides mechanisms for interacting with a database directly
|
Package db provides mechanisms for interacting with a database directly |
|
Package graph provides a mechanism for outputting haul assets in a graph using go-graphviz and cgraph
|
Package graph provides a mechanism for outputting haul assets in a graph using go-graphviz and cgraph |
|
Package handlers provides the functions for a echo webserver to serve the haul API routes
|
Package handlers provides the functions for a echo webserver to serve the haul API routes |
|
Package models provides the object models for haul requests and responses
|
Package models provides the object models for haul requests and responses |
|
Package responses contains structs for manipulating haul API responses
|
Package responses contains structs for manipulating haul API responses |