Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jalilbengoufa/pixicoreapi
Client API for google pixicore pxe boot.
https://github.com/jalilbengoufa/pixicoreapi
golang google netboot yaml
Last synced: 15 days ago
JSON representation
Client API for google pixicore pxe boot.
- Host: GitHub
- URL: https://github.com/jalilbengoufa/pixicoreapi
- Owner: jalilbengoufa
- Created: 2018-11-06T00:08:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-04T11:41:52.000Z (almost 6 years ago)
- Last Synced: 2024-11-07T05:35:17.779Z (2 months ago)
- Topics: golang, google, netboot, yaml
- Language: Go
- Homepage:
- Size: 17.4 MB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pixicoreAPI
## How to run the API
- Install go and [dep](https://github.com/golang/dep)- Install all the package dependencies with `dep ensure` inside project directory
- `go test ./... && go build ./cmd/pixicoreAPI && ./pixicoreAPI`
#### Using Docker
- `docker build -t pixicoreapi . `
- `docker run -d -p 3000:3000 pixicoreapi `
## Usage
- Change the IP address for each server in the `servers-config.yaml` file
- You can run `curl -i http://localhost:3000/v1/install/SERVER_MAC_ADDRESS` this will collect info and install coreOS for the server
- You can run `curl -i http://localhost:3000/v1/all/` this will collect info and install coreOS for each server
## API Endpoints
#### `GET v1/boot/:macAddress`
- Used by pixicore to get PXE config and boot each server (each server have a IP address assigned).
#### `GET v1/install/:macAddress`
- get information (cores,ram,etc) from the server using her macAddress as ID and install coresOS.
#### `GEt v1/all`
- get information (cores,ram,etc) from each the server using her macAddress as ID and install coresOS for each one.
#### `GEt v1/servers`
- show information about all the registred servers
### TO DO
- Unit tests
- https://semaphoreci.com/community/tutorials/test-driven-development-of-go-web-applications-with-gin
- https://medium.com/@craigchilds94/testing-gin-json-responses-1f258ce3b0b1