README
¶
gRPC Framework
This framework makes it simple for developers to add gRPC and automated REST interfaces for their Golang applications.
Usage
Please see our Documentation for more information.
- FYI, we are in the process of creating tutorials and adding more documentation to the framework
grpc-framework Development
Documentation for the website
- Setup the environment to write documentation
$ make doc-env
- Bring up the webserver
$ make doc-serve
Now edit the files in the direcory website.
- When done, build the website and add the
docsdir to git:
$ make doc-build
For more information on mkdocs go to:
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
auth
Package auth can be used for authentication and authorization Copyright 2018 Portworx
|
Package auth can be used for authentication and authorization Copyright 2018 Portworx |
|
auth/ownership
Package ownership manages access to resources Copyright 2019 Portworx
|
Package ownership manages access to resources Copyright 2019 Portworx |
|
auth/role
Package role manages roles in Kvdb and provides validation Copyright 2022 Pure Storage
|
Package role manages roles in Kvdb and provides validation Copyright 2022 Pure Storage |
|
defaultcontext
Package grpcutil is a package for gRPC utilities Copyright 2021 Portworx
|
Package grpcutil is a package for gRPC utilities Copyright 2021 Portworx |
|
grpc/client/creds_injector
Package grpcserver is a generic gRPC server manager Copyright 2018 Portworx
|
Package grpcserver is a generic gRPC server manager Copyright 2018 Portworx |
|
grpc/server
Package grpcserver is a generic gRPC server manager Copyright 2018 Portworx
|
Package grpcserver is a generic gRPC server manager Copyright 2018 Portworx |
|
test
|
|
|
app/api
Package api is a reverse proxy.
|
Package api is a reverse proxy. |
|
app/cmd/client
Example code
|
Example code |
Click to show internal directories.
Click to hide internal directories.