Cocos-91 - Update Makefile and cocos documentation (#93)

* Update Makefile

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update cocos documentation

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update cocos documentation

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update Makefile

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update Makefile

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update Makefile

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update cocos documentation

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Remove install rule from Makefile

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update agent README.md

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update agent README.md

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Update README.md files

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Remove INSTALL_DIR from Makefile

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

* Fix comments in README.md files

Signed-off-by: Jilks Smith <smithjilks@gmail.com>

---------

Signed-off-by: Jilks Smith <smithjilks@gmail.com>
This commit is contained in:
Smith Jilks
2024-04-08 16:59:38 +03:00
committed by GitHub
parent 3e3e02f132
commit b6f116474d
4 changed files with 11 additions and 32 deletions
-6
View File
@@ -5,8 +5,6 @@ GOARCH ?= amd64
VERSION ?= $(shell git describe --abbrev=0 --tags --always)
COMMIT ?= $(shell git rev-parse HEAD)
TIME ?= $(shell date +%F_%T)
CLI_SOURCE = ./cmd/cli/main.go
CLI_BIN = ${BUILD_DIR}/cocos-cli
empty:=
space:= $(empty) $(empty)
@@ -26,10 +24,6 @@ all: $(SERVICES)
$(SERVICES):
$(call compile_service,$(@))
install-cli: cli
cp ${CLI_BIN} ~/.local/bin/cocos-cli
protoc:
protoc -I. --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative agent/agent.proto
protoc -I. --go_out=./pkg --go_opt=paths=source_relative --go-grpc_out=./pkg --go-grpc_opt=paths=source_relative manager/manager.proto
+5 -5
View File
@@ -23,15 +23,15 @@ The service is configured using the environment variables from the following tab
To start the service outside of the container, execute the following shell script:
```bash
# download the latest version of the service
go get github.com/ultravioletrs/cocos
# Download the latest version of the service
git clone git@github.com:ultravioletrs/cocos.git
cd $GOPATH/src/github.com/ultravioletrs/cocos
cd cocos
# compile the agent
# Compile the service
make agent
# set the environment variables and run the service
# Run the service
./build/cocos-agent
```
+1 -13
View File
@@ -54,16 +54,4 @@ To retrieve the computation result, use the following command:
```bash
./build/cocos-cli agent result
```
## Installtion
To use the CLI, you have the option to install it globally on your system. Here's how:
### Build the CLI:
Navigate to the project root and run the following command to build the CLI binary:
```bash
make install-cli
```
```
+5 -8
View File
@@ -142,18 +142,15 @@ NB: we set environment variables that we will use in the shell process where we
To start the service, execute the following shell script (note a server needs to be running see [here](../test/manager-server/README.md)):
```bash
# download the latest version of the service
go get github.com/ultravioletrs/cocos
# Download the latest version of the service
git clone git@github.com:ultravioletrs/cocos.git
cd $GOPATH/src/github.com/ultravioletrs/cocos
cd cocos
# compile the manager
# Compile the manager
make manager
# copy binary to bin
make install
# set the environment variables and run the service
# Set the environment variables and run the service
MANAGER_GRPC_URL=localhost:7001
MANAGER_LOG_LEVEL=debug \
MANAGER_QEMU_USE_SUDO=false \