Skip to content

Commit

Permalink
Address feedbacks
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeffwan committed Nov 24, 2021
1 parent a83e444 commit 3128084
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/design/protobuf-grpc-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,23 @@ Due to above reason, it's worth to build generic abstraction on top of RayCluste

## Proposal

### Deployment topology and interactive flow

The new gRPC service would be a individual deployment of the KubeRay control plane and user can choose to install it optinally. It will create a service and exposes endpoint to users.

```
NAME READY STATUS RESTARTS AGE
kuberay-grpc-service-c8db9dc65-d4w5r 1/1 Running 0 2d15h
kuberay-operator-785476b948-fmlm7 1/1 Running 0 3d
```

In issue [#29](https://github.com/ray-project/kuberay/issues/29), `RayCluster` CRD clientset has been generated and gRPC service can leverage it to operate Custom Resources.

A simple flow would be like this. (Thanks [@akanso](https://github.com/akanso) for providing the flow)
```
client --> GRPC Server --> [created Custom Resources] <-- Ray Operator (reads CR and accordingly performs CRUD)
```

### API abstraction

Protocol Buffers are a language-neutral, platform-neutral extensible mechanism for serializing structured data. Protoc also provides different community plugins to meet different needs.
Expand Down Expand Up @@ -157,6 +174,6 @@ The service will implement gPRC server as following graph shows.

## Implementation History

- 2021-11-0x: inital proposal accepted.
- 2021-11-25: inital proposal accepted.

> Note: we should update doc when there's a large update.

0 comments on commit 3128084

Please sign in to comment.