Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

Commit

Permalink
quote-server/README.md: update according to comments
Browse files Browse the repository at this point in the history
  • Loading branch information
hairongchen committed Jul 17, 2023
1 parent d4e5aad commit 2455986
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions service/quote-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ This service will provide quote generated by underlying TEE platform for remote

## Introduction

This service provides functionality to fetch quote of underlying TEE platform with nonce as mandatory input and a base64 encoded user data as optional input. The nonce and optional user data will be digested and added into quote for remote attestation to verify the freshness of the quote and the user specified data.
This service provides functionality to fetch quote of underlying TEE platform with nonce as mandatory input and a base64 encoded user data as optional input. The nonce and user data will be digested and added into quote for remote attestation to verify the freshness of the quote and the user specified data.

The quote server use Unix domain socket based gRPC to serve the client SDK and the proto buffer message is as bellow:
The quote server uses Unix domain socket based gRPC to serve the client SDK. And the proto buffer message is as bellow:

```
message HealthCheckRequest {
Expand Down Expand Up @@ -40,7 +40,7 @@ message GetQuoteResponse {
```

## Installation
The quote service can be deployed as either DaemonSet or sidecar in different user scenarios.
The quote service can be deployed as either DaemonSet or sidecar according to different user scenarios.

### Build docker image
The Dockerfile for the service can be found under `container/quote-server` directory. Use the following command to build the image:
Expand All @@ -49,7 +49,7 @@ The Dockerfile for the service can be found under `container/quote-server` direc
docker build -t ccnp_get_quote:0.1 -f container/quote-server/Dockerfile .
```

> Note: if you are using containerd as the default runtime for kubernetes. Please remember to use the following command to import the image into containerd:
> Note: if you are using containerd as the default runtime for kubernetes, don't forget to use the following commands to import the image into containerd first:
```
docker save -o ccnp-quote-server.tar ccnp_get_quote:0.1
ctr -n=k8s.io image import ccnp-quote-server.tar
Expand Down

0 comments on commit 2455986

Please sign in to comment.