Documentation
¶
Overview ¶
protoc-gen-onexmesh-client is a plugin for the protocol buffer compiler that generates a client-go style REST SDK (clientset + typed clients + scheme + fake + informers + listers + applyconfigurations) from protobuf IDL, plus a mesh-aware gRPC client for services flagged with onexmesh.v1.mesh_service. The gRPC SDK itself is generated by the standard protoc-gen-go-grpc plugin.
Install it by building this program and placing it on your PATH as protoc-gen-onexmesh-client. The "onexmesh-client" suffix becomes part of the protoc argument:
protoc --onexmesh-client_out=. path/to/file.proto
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
generators
Package generators holds the code generators that produce the client-go style REST SDK.
|
Package generators holds the code generators that produce the client-go style REST SDK. |
|
generators/applycfg
Package applycfg generates per-version apply configuration types (<Kind>ApplyConfiguration) that power server-side apply through the gentype ClientWithListAndApply / FakeClientWithListAndApply variants.
|
Package applycfg generates per-version apply configuration types (<Kind>ApplyConfiguration) that power server-side apply through the gentype ClientWithListAndApply / FakeClientWithListAndApply variants. |
|
generators/fake
Package fake generates the fake clientset and fake typed clients, enabling in-memory CRUD for testing (mirroring k8s.io/client-go's fake package).
|
Package fake generates the fake clientset and fake typed clients, enabling in-memory CRUD for testing (mirroring k8s.io/client-go's fake package). |
|
generators/informer
Package informer generates the informers/ subtree (factory, group/version interfaces, per-resource informers) in the client-go style.
|
Package informer generates the informers/ subtree (factory, group/version interfaces, per-resource informers) in the client-go style. |
|
generators/lister
Package lister generates listers/<group>/<version>/<kind>.go and the expansion interfaces, in the client-go style (backed by k8s.io/client-go/listers.ResourceIndexer).
|
Package lister generates listers/<group>/<version>/<kind>.go and the expansion interfaces, in the client-go style (backed by k8s.io/client-go/listers.ResourceIndexer). |
|
generators/mesh
Package mesh renders the onexmesh service-discovery client for a gRPC service, generated only when the file declares onexmesh.v1.mesh_service.
|
Package mesh renders the onexmesh service-discovery client for a gRPC service, generated only when the file declares onexmesh.v1.mesh_service. |
|
generators/meta
Package meta generates the zz_generated.meta.go adapter that makes a generated proto message satisfy runtime.Object and metav1.Object, the type constraints required by k8s.io/client-go/gentype.
|
Package meta generates the zz_generated.meta.go adapter that makes a generated proto message satisfy runtime.Object and metav1.Object, the type constraints required by k8s.io/client-go/gentype. |
|
generators/register
Package register generates zz_generated.register.go, which registers the resource types of a group/version into a runtime.Scheme (mirroring the output of k8s.io/code-generator's register-gen).
|
Package register generates zz_generated.register.go, which registers the resource types of a group/version into a runtime.Scheme (mirroring the output of k8s.io/code-generator's register-gen). |
|
generators/scheme
Package scheme generates the clientset scheme/register.go, which aggregates the AddToScheme of every group/version into a single runtime.Scheme.
|
Package scheme generates the clientset scheme/register.go, which aggregates the AddToScheme of every group/version into a single runtime.Scheme. |
|
generators/templates
Package templates renders the client-go style SDK source from the spec IR via text/template.
|
Package templates renders the client-go style SDK source from the spec IR via text/template. |
|
generators/typed
Package typed generates the clientset, per-group client and per-resource typed client files in the client-go style (gentype-backed).
|
Package typed generates the clientset, per-group client and per-resource typed client files in the client-go style (gentype-backed). |
|
spec
Package spec defines the intermediate representation consumed by all generators.
|
Package spec defines the intermediate representation consumed by all generators. |
Click to show internal directories.
Click to hide internal directories.