Document the api service #1915
Document the api service #1915
Conversation
yifan-gu
force-pushed
the
doc_api_service
branch
from
6a211fe
to
ba96435
Compare
yifan-gu
force-pushed
the
doc_api_service
branch
2 times, most recently
from
999718c
to
151839a
Compare
|
|
||
| The API service is designed to help users to get a well defined and structual result for listing and introspecting their pods and images. | ||
| The API service is implemented with [gRPC](http://www.grpc.io/). | ||
| The API service is designed not to be running as a root, thus it currently only provides read-only interfaces for now. |
There was a problem hiding this comment.
Change to:
"The API service is designed to run without root privileges, and currently provides a read-only interface."
yifan-gu
force-pushed
the
doc_api_service
branch
from
151839a
to
6c13f96
Compare
|
@joshix Thanks, I updated. |
| ## Running the API service | ||
|
|
||
| The API service is implemented by the `rkt api-service` command. | ||
| When started, it will listen on the URL that provided by `--listen-client-url` flag for the incoming gRPC requests. |
There was a problem hiding this comment.
s/that//
s/by/by the/
s/the incoming/incoming/
|
@yifan-gu I found |
yifan-gu
force-pushed
the
doc_api_service
branch
from
6c13f96
to
435f514
Compare
|
@joshix Thanks for catching these :) |
yifan-gu
force-pushed
the
doc_api_service
branch
from
435f514
to
e2db311
Compare
| ## Running the API service | ||
|
|
||
| The API service is implemented by the `rkt api-service` command. | ||
| When started, it will listen on the URL provided by the `--listen-client-url` flag for incoming gRPC requests. |
There was a problem hiding this comment.
The API service listens for gRPC requests on all interfaces on the port specified by the --listen-port option. The default port is number 15441.
Or, with the proposed --listen:
The API service listens for gRPC requests on the address and port specified by the --listen option. The default is to listen on all interfaces on port number 15441, equivalent to invoking api-service --listen=0.0.0.0:15441.
There was a problem hiding this comment.
@joshix I feel we'd better listen on localhost by default so that it won't accept any incoming requests from outside by default?
There was a problem hiding this comment.
Ah, yes, good call. I have to agree.
So, to re-summarize and re-re-write this line:
The API service listens for gRPC requests on the address and port specified by the --listen option. The default is to listen on the loopback interface on port number 15441, equivalent to invoking rkt api-service --listen=127.0.0.1:15441. Specify the address 0.0.0.0 to listen on all interfaces.
yifan-gu
force-pushed
the
doc_api_service
branch
3 times, most recently
from
f7663bb
to
9c3c311
Compare
| ## Using the API service | ||
|
|
||
| The interfaces are defined in the [protobuf here](../../api/v1alpha/api.proto). | ||
| Here is a small [Go program](../../api/v1alpha/client_example.go) that illustrates how to uses the API service. |
yifan-gu
force-pushed
the
doc_api_service
branch
from
9c3c311
to
de76769
Compare
yifan-gu
force-pushed
the
doc_api_service
branch
from
de76769
to
a201043
Compare
yifan-gu
force-pushed
the
doc_api_service
branch
from
a201043
to
8c3966e
Compare
|
@joshix Updated according to your comments :) |
|
I think this is a go. Thanks for sticking with it through so many revs. |
|
@jonboulle Final call |
Also add a small example program shows how to using the api service.
And fixed a flag bug.