Skip to content

Commit

Permalink
docs: Improve RVPS document
Browse files Browse the repository at this point in the history
This PR tries to improve the RVPS document, first by putting a pre-requisite
to avoid the failure when building the RVPS and by correcting a command that will fail otherwise when installing the RVPS.

Signed-off-by: Gabriela Cervantes <[email protected]>
  • Loading branch information
GabyCT authored and fitzthum committed Feb 7, 2024
1 parent b8600ec commit c90c0ee
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions attestation-service/rvps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ It is the reference values really requested and used by Attestation Service to c

## Run RVPS

### Pre-requisite

Install the protocol buffer compiler package `protobuf-compiler`.

### Directly Build

In this way, the RVPS can run as a single service. The [gRPC protos](../protos/reference.proto) are defined.
Expand All @@ -53,7 +57,7 @@ We can run using the following command
```bash
git clone https://github.com/confidential-containers/kbs
cd kbs/attestation-service/rvps
make build && make install
make build && sudo make install
```

To by default listen to `localhost:50003` to wait for requests
Expand Down Expand Up @@ -148,4 +152,4 @@ Then the reference values will be output
```
[2023-03-09T05:13:50Z INFO rvps_client] Get reference values succeeded:
["reference-value-1","reference-value-2"]
```
```

0 comments on commit c90c0ee

Please sign in to comment.