1111
1212## Overview
1313
14- The purpose of the Host Manager is to manage a host’s hardware information and It also implements connection tracking
14+ The purpose of the Host Resource Manager is to manage a host’s hardware information. It also implements connection tracking
1515and reconciliation.
16- Host Resource Manager collects all of this data, such as CPU, Memory, Disk, GPU, Interfaces and such, with the help
16+ The Host Resource Manager collects all of this data, such as CPU, Memory, Disk, GPU, Interfaces and such, with the help
1717of Hardware Discovery Agent (HDA) on the Edge Node.
18- The Host Resource Manager stores this data in inventory so that other components (like UI and Cluster Orchestration)
18+ The Host Resource Manager stores this data in the Inventory so that other components (like UI and Cluster Orchestration)
1919can retrieve and act on it.
2020
21- Host Manager uses TLS with JWT (Json Web Tokens) technology to make the communication from the orchestrator to the edge
22- node secure.
21+ The Host Resource Manager uses TLS with JWT (Json Web Tokens) technology to make the communication from the orchestrator
22+ to the edge node secure.
2323
2424## Features
2525
@@ -29,7 +29,7 @@ node secure.
2929
3030## Get Started
3131
32- Instructions on how to install and set up host Resource Manager on your development machine.
32+ Instructions on how to install and set up the Host Resource Manager on your development machine.
3333
3434### Dependencies
3535
@@ -42,19 +42,19 @@ make dependency-check
4242
4343This code requires the following tools to be installed on your development machine:
4444
45- - [ Go\* programming language] ( https://go.dev ) - check [ $GOVERSION_REQ] ( Makefile )
46- - [ golangci-lint] ( https://github.com/golangci/golangci-lint ) - check [ $GOLINTVERSION_REQ] ( Makefile )
47- - [ go-junit-report] ( https://github.com/jstemmer/go-junit-report ) - check [ $GOJUNITREPORTVERSION_REQ] ( Makefile )
48- - [ gocover-cobertura] ( github.com/boumenot/gocover-cobertura ) - check [ $GOCOBERTURAVERSION_REQ] ( Makefile )
49- - [ protoc-gen-doc] ( https://github.com/pseudomuto/protoc-gen-doc ) - check [ $PROTOCGENDOCVERSION_REQ] ( Makefile )
50- - [ buf] ( https://github.com/bufbuild/buf ) - check [ $BUFVERSION_REQ] ( Makefile )
51- - [ protoc-gen-go] ( https://pkg.go.dev/google.golang.org/protobuf ) - check [ $PROTOCGENGOVERSION_REQ] ( Makefile )
52- - [ protoc-gen-go-grpc] ( https://pkg.go.dev/google.golang.org/grpc ) - check [ $PROTOCGENGOGRPCVERSION_REQ] ( Makefile )
53- - [ gnostic] ( https://pkg.go.dev/github.com/google/gnostic ) - check [ GNOSTICVERSION_REQ] ( Makefile )
54- - [ protoc-gen-validate] ( https://pkg.go.dev/github.com/envoyproxy/protoc-gen-validate ) - check [ PROTOCGENVALIDATEGOVERSION_REQ] ( Makefile )
55- - [ gnostic-grpc] ( https://pkg.go.dev/github.com/googleapis/gnostic-grpc ) - check [ GNOSTICGRPCVERSION_REQ] ( Makefile )
45+ - [ Go\* programming language] ( https://go.dev ) - check [ $GOVERSION_REQ] ( ../version.mk )
46+ - [ golangci-lint] ( https://github.com/golangci/golangci-lint ) - check [ $GOLINTVERSION_REQ] ( ../version.mk )
47+ - [ go-junit-report] ( https://github.com/jstemmer/go-junit-report ) - check [ $GOJUNITREPORTVERSION_REQ] ( ../version.mk )
48+ - [ gocover-cobertura] ( https:// github.com/boumenot/gocover-cobertura) - check [ $GOCOBERTURAVERSION_REQ] ( ../version.mk )
49+ - [ protoc-gen-doc] ( https://github.com/pseudomuto/protoc-gen-doc ) - check [ $PROTOCGENDOCVERSION_REQ] ( ../version.mk )
50+ - [ buf] ( https://github.com/bufbuild/buf ) - check [ $BUFVERSION_REQ] ( ../version.mk )
51+ - [ protoc-gen-go] ( https://pkg.go.dev/google.golang.org/protobuf ) - check [ $PROTOCGENGOVERSION_REQ] ( ../version.mk )
52+ - [ protoc-gen-go-grpc] ( https://pkg.go.dev/google.golang.org/grpc ) - check [ $PROTOCGENGOGRPCVERSION_REQ] ( ../version.mk )
53+ - [ gnostic] ( https://pkg.go.dev/github.com/google/gnostic ) - check [ GNOSTICVERSION_REQ] ( ../version.mk )
54+ - [ protoc-gen-validate] ( https://pkg.go.dev/github.com/envoyproxy/protoc-gen-validate ) - check [ PROTOCGENVALIDATEGOVERSION_REQ] ( ../version.mk )
55+ - [ gnostic-grpc] ( https://pkg.go.dev/github.com/googleapis/gnostic-grpc ) - check [ GNOSTICGRPCVERSION_REQ] ( ../version.mk )
5656- [ protoc-gen-grpc-gateway] ( https://pkg.go.dev/github.com/grpc-ecosystem/grpc-gateway/v2@v2.26.0/protoc-gen-grpc-gateway )
57- - check [ PROTOCGENGRPCGATEWAY_REQ] ( Makefile )
57+ - check [ PROTOCGENGRPCGATEWAY_REQ] ( ../version.mk )
5858
5959You can install Go dependencies by running ` make go-dependency ` .
6060
@@ -71,14 +71,13 @@ The binary is installed in the [$OUT_DIR](../common.mk) folder.
7171
7272## Usage
7373
74- This guide shows how to deploy Host Resource Manger for local development or testing.
74+ This guide shows how to deploy the Host Resource Manger for local development or testing.
7575For production deployments use the [ Edge Infrastructure Manager charts] [ inframanager-charts ] .
7676
77- > Note: To run host manager, Inventory need to be running as the host manager need to register as an inventory client.
78- > Please refer to the TODO
79- > [ instruction of Inventory] ( https://github.com/open-edge-platform/infra-core/tree/main/inventory#usage )
80- > and [ Database in Inventory] ( https://github.com/open-edge-platform/infra-core/blob/main/inventory/docs/database.md )
81- > for more information about how to run inventory.
77+ > Note: To run the Host Resource Manager, Inventory must be running as the manager needs to register as an Inventory client.
78+ > Please refer to the [ Inventory instructions] ( https://github.com/open-edge-platform/infra-core/tree/main/inventory#usage )
79+ > and [ database in Inventory] ( https://github.com/open-edge-platform/infra-core/blob/main/inventory/docs/database.md )
80+ > for more information about how to run Inventory.
8281
8382### Run Host Resource Manager
8483
@@ -88,11 +87,11 @@ make go-run
8887
8988See the [ documentation] [ user-guide-url ] if you want to learn more about using Edge Orchestrator.
9089
91- For any issues the [ Troubleshooting guide] [ troubleshooting-url ] .
90+ For any issues, refer to the [ Troubleshooting guide] [ troubleshooting-url ] .
9291
9392## Functional Test
9493
95- Run the make target ` test ` to mock agents to perform the relative behaviors for host resources.
94+ Run the make target ` test ` to mock agents to simulate the relative behaviors for host resources.
9695
9796``` bash
9897make test
@@ -118,11 +117,11 @@ targets. The following is a list of makefile targets that support developer acti
118117For additional information:
119118
120119- See the [ docs] ( docs/api/hostmgr.md ) for the Host Resource Manager APIs
121- - See[ Edge Infrastructure Manager developer documentation] [ inframanager-dev-guide-url ] for internals and
120+ - See [ Edge Infrastructure Manager developer documentation] [ inframanager-dev-guide-url ] for internals and
122121 software architecture.
123122
124- [ user-guide-url ] : https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/ user_guide/get_started_guide/gsg_content .html
125- [ inframanager-dev-guide-url ] : ( https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content .html)
126- [ contributors-guide-url ] : https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide /index.html
127- [ troubleshooting-url ] : https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/ user_guide/troubleshooting/troubleshooting .html
123+ [ user-guide-url ] : https://docs.openedgeplatform.intel.com/edge-manage-docs/main/ user_guide/get_started_guide/index .html
124+ [ inframanager-dev-guide-url ] : https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/infra_manager/index .html
125+ [ contributors-guide-url ] : https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide /index.html
126+ [ troubleshooting-url ] : https://docs.openedgeplatform.intel.com/edge-manage-docs/main/ user_guide/troubleshooting/index .html
128127[ inframanager-charts ] : https://github.com/open-edge-platform/infra-charts
0 commit comments